Remove BugBug in comments and adjust function header according to code style doc.

[mirror_edk2.git] / MdePkg / Include / Ppi / DeviceRecoveryModule.h

diff --git a/MdePkg/Include/Ppi/DeviceRecoveryModule.h b/MdePkg/Include/Ppi/DeviceRecoveryModule.h
index 3847686b047d36a7c6ffdb933a9047ce13856ee7..46c5cdeaae084567e54230ce438badeaef452f4a 100644 (file)
--- a/MdePkg/Include/Ppi/DeviceRecoveryModule.h
+++ b/MdePkg/Include/Ppi/DeviceRecoveryModule.h
@@ -34,19 +34,15 @@ typedef struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI EFI_PEI_DEVICE_RECOVERY_MODUL
   the capsules discovered. Entry 1 is assumed to be the highest load priority \r
   and entry N is assumed to be the lowest priority.\r
 \r
-  @param  PeiServices General-purpose services that are available to every PEIM\r
-  \r
-  @param  This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
-  \r
-  @param  NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On output, \r
-  *NumberRecoveryCapsules contains the number of recovery capsule images available \r
-  for retrieval from this PEIM instance.\r
-\r
-  @retval EFI_SUCCESS One or more capsules were discovered.\r
-  \r
-  @retval EFI_DEVICE_ERROR A device error occurred.\r
-  \r
-  @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.\r
+  @param  PeiServices            General-purpose services that are available to every PEIM\r
+  @param  This                   Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
+  @param  NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On output,\r
+                                 *NumberRecoveryCapsules contains the number of recovery capsule \r
+                                 images available for retrieval from this PEIM instance.\r
+\r
+  @retval EFI_SUCCESS           One or more capsules were discovered.\r
+  @retval EFI_DEVICE_ERROR      A device error occurred.\r
+  @retval EFI_NOT_FOUND         A recovery DXE capsule cannot be found.\r
 \r
 **/\r
 typedef\r
@@ -60,23 +56,17 @@ EFI_STATUS
 /**\r
   This function gets the size and type of the requested recovery capsule.\r
 \r
-  @param  PeiServices General-purpose services that are available to every PEIM\r
-  \r
-  @param  This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
-  \r
+  @param  PeiServices     General-purpose services that are available to every PEIM\r
+  @param  This            Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
   @param  CapsuleInstance Specifies for which capsule instance to retrieve the information.\r
-  \r
-  @param  Size A pointer to a caller-allocated UINTN in which the size of \r
-  the requested recovery module is returned.\r
-  \r
-  @param  CapsuleType A pointer to a caller-allocated EFI_GUID in \r
-  which the type of the requested recovery capsule is returned.\r
-\r
-  @retval EFI_SUCCESS One or more capsules were discovered.\r
-  \r
-  @retval EFI_DEVICE_ERROR A device error occurred.\r
-  \r
-  @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.\r
+  @param  Size            A pointer to a caller-allocated UINTN in which the size of\r
+                          the requested recovery module is returned.\r
+  @param  CapsuleType     A pointer to a caller-allocated EFI_GUID in\r
+                          which the type of the requested recovery capsule is returned.\r
+\r
+  @retval EFI_SUCCESS           One or more capsules were discovered.\r
+  @retval EFI_DEVICE_ERROR      A device error occurred.\r
+  @retval EFI_NOT_FOUND         A recovery DXE capsule cannot be found.\r
 \r
 **/\r
 typedef\r
@@ -93,19 +83,15 @@ EFI_STATUS
   This function, by whatever mechanism, retrieves a DXE capsule from some device \r
   and loads it into memory. Note that the published interface is device neutral.\r
 \r
-  @param  PeiServices General-purpose services that are available to every PEIM\r
-  \r
-  @param  This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
-  \r
+  @param  PeiServices     General-purpose services that are available to every PEIM\r
+  @param  This            Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.\r
   @param  CapsuleInstance Specifies which capsule instance to retrieve.\r
-  \r
-  @param  Buffer Specifies a caller-allocated buffer in which the requested recovery capsule will be returned. \r
-\r
-  @retval EFI_SUCCESS One or more capsules were discovered.\r
-  \r
-  @retval EFI_DEVICE_ERROR A device error occurred.\r
-  \r
-  @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.\r
+  @param  Buffer          Specifies a caller-allocated buffer in which the requested \r
+                          recovery capsule will be returned.\r
+\r
+  @retval EFI_SUCCESS           One or more capsules were discovered.\r
+  @retval EFI_DEVICE_ERROR      A device error occurred.\r
+  @retval EFI_NOT_FOUND         A recovery DXE capsule cannot be found.\r
 \r
 **/\r
 typedef\r