Clean up formatting and some Doxygen comments.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8746 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
index aee8d0cd46fce2b928a5de8f2de4df5a013bd21e..6dd525a859449022a1d4d120534d4ff32401ecb2 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
+++ b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
@@ -17,8 +17,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-  Module Name:  DeviceRecoveryModule.h\r
-\r
   @par Revision Reference:\r
   This PPI is defined in Framework of EFI Recovery spec.\r
   Version 0.9\r
@@ -38,10 +36,9 @@
 typedef struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI EFI_PEI_DEVICE_RECOVERY_MODULE_PPI;\r
 \r
 /**\r
-  This function, by whatever mechanism, searches for DXE capsules from the\r
-  associated device and returns the number and maximum size in bytes of\r
-  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
+  This function searches for DXE capsules from the associated device and returns the number\r
+  and maximum size in bytes of the capsules discovered. Entry 1 is assumed to be the\r
+  highest load priority and entry N is assumed to be the lowest priority.\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
@@ -57,9 +54,9 @@ typedef struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI EFI_PEI_DEVICE_RECOVERY_MODUL
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_DEVICE_GET_NUMBER_RECOVERY_CAPSULE)(\r
-  IN EFI_PEI_SERVICES                               **PeiServices,\r
-  IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI             *This,\r
-  OUT UINTN                                         *NumberRecoveryCapsules\r
+  IN     EFI_PEI_SERVICES                               **PeiServices,\r
+  IN     EFI_PEI_DEVICE_RECOVERY_MODULE_PPI             *This,\r
+     OUT UINTN                                          *NumberRecoveryCapsules\r
   );\r
 \r
 /**\r
@@ -81,16 +78,16 @@ EFI_STATUS
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_DEVICE_GET_RECOVERY_CAPSULE_INFO)(\r
-  IN  EFI_PEI_SERVICES                              **PeiServices,\r
-  IN  EFI_PEI_DEVICE_RECOVERY_MODULE_PPI            *This,\r
-  IN  UINTN                                         CapsuleInstance,\r
-  OUT UINTN                                         *Size,\r
-  OUT EFI_GUID                                      *CapsuleType\r
+  IN     EFI_PEI_SERVICES                              **PeiServices,\r
+  IN     EFI_PEI_DEVICE_RECOVERY_MODULE_PPI            *This,\r
+  IN     UINTN                                         CapsuleInstance,\r
+     OUT UINTN                                         *Size,\r
+     OUT EFI_GUID                                      *CapsuleType\r
   );\r
 \r
 /**\r
-  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
+  This function retrieves a DXE capsule from some device and loads it into memory.\r
+  Note that the published interface is device neutral.\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
@@ -107,9 +104,9 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE)(\r
   IN OUT EFI_PEI_SERVICES                         **PeiServices,\r
-  IN EFI_PEI_DEVICE_RECOVERY_MODULE_PPI           *This,\r
-  IN UINTN                                        CapsuleInstance,\r
-  OUT VOID                                        *Buffer\r
+  IN     EFI_PEI_DEVICE_RECOVERY_MODULE_PPI       *This,\r
+  IN     UINTN                                    CapsuleInstance,\r
+     OUT VOID                                     *Buffer\r
   );\r
 \r
 ///\r
@@ -135,4 +132,4 @@ struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI {
 \r
 extern EFI_GUID gEfiPeiDeviceRecoveryModulePpiGuid;\r
 \r
-#endif\r
+#endif  /* _PEI_DEVICE_RECOVERY_MODULE_PPI_H_ */\r