]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdeModulePkg/Core/Dxe/Library.h
Code Scrub for Dxe Core.
[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Library.h
index a489bd59d1998c1d5e251e1cafebe50103eb473d..a3fce51a28706a8910f5c9c1a400374d7e3759d8 100644 (file)
@@ -20,8 +20,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 /**\r
   Report status code of type EFI_PROGRESS_CODE by caller ID gEfiCallerIdGuid.\r
 \r
-  @param  Value              Describes the class/subclass/operation of the \r
-                             hardware or software entity that the Status Code \r
+  @param  Value              Describes the class/subclass/operation of the\r
+                             hardware or software entity that the Status Code\r
                              relates to.\r
 \r
 **/\r
@@ -35,9 +35,9 @@ CoreReportProgressCode (
   Report status code of type EFI_PROGRESS_CODE by caller ID gEfiCallerIdGuid,\r
   with a handle as additional information.\r
 \r
-  @param  Value              Describes the class/subclass/operation of the \r
-                             hardware or software entity that the Status Code \r
-                             relates to. \r
+  @param  Value              Describes the class/subclass/operation of the\r
+                             hardware or software entity that the Status Code\r
+                             relates to.\r
   @param  Handle             Additional information.\r
 \r
 **/\r
@@ -52,7 +52,7 @@ CoreReportProgressCodeSpecific (
   Raising to the task priority level of the mutual exclusion\r
   lock, and then acquires ownership of the lock.\r
 \r
-  @param  Lock               The lock to acquire \r
+  @param  Lock               The lock to acquire\r
 \r
   @return Lock owned\r
 \r
@@ -70,9 +70,9 @@ CoreAcquireLock (
   multiprocessor support, acquiring the lock only consists\r
   of raising to the locks TPL.\r
 \r
-  @param  Lock               The EFI_LOCK structure to initialize \r
+  @param  Lock               The EFI_LOCK structure to initialize\r
 \r
-  @retval EFI_SUCCESS        Lock Owned. \r
+  @retval EFI_SUCCESS        Lock Owned.\r
   @retval EFI_ACCESS_DENIED  Reentrant Lock Acquisition, Lock not Owned.\r
 \r
 **/\r
@@ -86,7 +86,7 @@ CoreAcquireLockOrFail (
   Releases ownership of the mutual exclusion lock, and\r
   restores the previous task priority level.\r
 \r
-  @param  Lock               The lock to release \r
+  @param  Lock               The lock to release\r
 \r
   @return Lock unowned\r
 \r
@@ -104,7 +104,7 @@ CoreReleaseLock (
 /**\r
   Calculate the size of a whole device path.\r
 \r
-  @param  DevicePath         The pointer to the device path data. \r
+  @param  DevicePath         The pointer to the device path data.\r
 \r
   @return Size of device path data structure..\r
 \r
@@ -118,9 +118,9 @@ CoreDevicePathSize (
 /**\r
   Return TRUE is this is a multi instance device path.\r
 \r
-  @param  DevicePath         A pointer to a device path data structure. \r
+  @param  DevicePath         A pointer to a device path data structure.\r
 \r
-  @retval TRUE               If DevicePath is multi instance. FALSE - If \r
+  @retval TRUE               If DevicePath is multi instance. FALSE - If\r
                              DevicePath is not multi instance.\r
 \r
 **/\r
@@ -134,7 +134,7 @@ CoreIsDevicePathMultiInstance (
 /**\r
   Duplicate a new device path data structure from the old one.\r
 \r
-  @param  DevicePath         A pointer to a device path data structure. \r
+  @param  DevicePath         A pointer to a device path data structure.\r
 \r
   @return A pointer to the new allocated device path data.\r
   @return Caller must free the memory used by DevicePath if it is no longer needed.\r
@@ -149,8 +149,8 @@ CoreDuplicateDevicePath (
 /**\r
   Function is used to append a Src1 and Src2 together.\r
 \r
-  @param  Src1               A pointer to a device path data structure. \r
-  @param  Src2               A pointer to a device path data structure. \r
+  @param  Src1               A pointer to a device path data structure.\r
+  @param  Src2               A pointer to a device path data structure.\r
 \r
   @return A pointer to the new device path is returned.\r
   @return NULL is returned if space for the new device path could not be allocated from pool.\r
@@ -167,7 +167,7 @@ CoreAppendDevicePath (
 /**\r
   Allocate pool of type EfiBootServicesData, the size is specified with AllocationSize.\r
 \r
-  @param  AllocationSize     Size to allocate. \r
+  @param  AllocationSize     Size to allocate.\r
 \r
   @return Pointer of the allocated pool.\r
 \r
@@ -181,7 +181,7 @@ CoreAllocateBootServicesPool (
 /**\r
   Allocate pool of type EfiBootServicesData and zero it, the size is specified with AllocationSize.\r
 \r
-  @param  AllocationSize     Size to allocate. \r
+  @param  AllocationSize     Size to allocate.\r
 \r
   @return Pointer of the allocated pool.\r
 \r
@@ -195,11 +195,11 @@ CoreAllocateZeroBootServicesPool (
 /**\r
   Find a config table by name in system table's ConfigurationTable.\r
 \r
-  @param  Guid           The table name to look for \r
-  @param  Table          Pointer of the config table \r
+  @param  Guid           The table name to look for\r
+  @param  Table          Pointer of the config table\r
 \r
-  @retval EFI_NOT_FOUND  Could not find the table in system table's \r
-                         ConfigurationTable. \r
+  @retval EFI_NOT_FOUND  Could not find the table in system table's\r
+                         ConfigurationTable.\r
   @retval EFI_SUCCESS    Table successfully found.\r
 \r
 **/\r
@@ -213,9 +213,9 @@ CoreGetConfigTable (
 /**\r
   Allocate pool of specified size with EfiRuntimeServicesData type, and copy specified buffer to this pool.\r
 \r
-  @param  AllocationSize     Size to allocate. \r
-  @param  Buffer             Specified buffer that will be copy to the allocated \r
-                             pool \r
+  @param  AllocationSize     Size to allocate.\r
+  @param  Buffer             Specified buffer that will be copy to the allocated\r
+                             pool\r
 \r
   @return Pointer of the allocated pool.\r
 \r
@@ -230,7 +230,7 @@ CoreAllocateRuntimeCopyPool (
 /**\r
   Allocate pool of type EfiRuntimeServicesData, the size is specified with AllocationSize.\r
 \r
-  @param  AllocationSize     Size to allocate. \r
+  @param  AllocationSize     Size to allocate.\r
 \r
   @return Pointer of the allocated pool.\r
 \r
@@ -244,9 +244,9 @@ CoreAllocateRuntimePool (
 /**\r
   Allocate pool of specified size with EfiBootServicesData type, and copy specified buffer to this pool.\r
 \r
-  @param  AllocationSize     Size to allocate. \r
-  @param  Buffer             Specified buffer that will be copy to the allocated \r
-                             pool \r
+  @param  AllocationSize     Size to allocate.\r
+  @param  Buffer             Specified buffer that will be copy to the allocated\r
+                             pool\r
 \r
   @return Pointer of the allocated pool.\r
 \r
@@ -261,14 +261,14 @@ CoreAllocateCopyPool (
 /**\r
   Create a protocol notification event and return it.\r
 \r
-  @param  ProtocolGuid       Protocol to register notification event on. \r
-  @param  NotifyTpl          Maximum TPL to signal the NotifyFunction. \r
-  @param  NotifyFunction     EFI notification routine. \r
-  @param  NotifyContext      Context passed into Event when it is created. \r
-  @param  Registration       Registration key returned from \r
-                             RegisterProtocolNotify(). \r
-  @param  SignalFlag         Boolean value to decide whether kick the event after \r
-                             register or not. \r
+  @param  ProtocolGuid       Protocol to register notification event on.\r
+  @param  NotifyTpl          Maximum TPL to signal the NotifyFunction.\r
+  @param  NotifyFunction     EFI notification routine.\r
+  @param  NotifyContext      Context passed into Event when it is created.\r
+  @param  Registration       Registration key returned from\r
+                             RegisterProtocolNotify().\r
+  @param  SignalFlag         Boolean value to decide whether kick the event after\r
+                             register or not.\r
 \r
   @return The EFI_EVENT that has been registered to be signaled when a ProtocolGuid\r
           is added to the system.\r