Clean up formatting and some Doxygen comments.

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

diff --git a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
index 2139d158bf1847c5189cf0092cf3e7ad2b068056..6dd525a859449022a1d4d120534d4ff32401ecb2 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
+++ b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
@@ -8,7 +8,7 @@
   module determines the internal search order, with capsule number 1 as the highest load priority and\r
   number N as the lowest priority.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -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
@@ -56,10 +53,10 @@ typedef struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI EFI_PEI_DEVICE_RECOVERY_MODUL
 **/\r
 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
+(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
   );\r
 \r
 /**\r
@@ -80,17 +77,17 @@ EFI_STATUS
 **/\r
 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
+(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
   );\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
@@ -105,34 +102,34 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE) (\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
-  @par Ppi Description:\r
-  Presents a standard interface to EFI_PEI_DEVICE_RECOVERY_MODULE_PPI,\r
-  regardless of the underlying device(s).\r
-\r
-  @param GetNumberRecoveryCapsules\r
-  Returns the number of DXE capsules that were found.\r
-\r
-  @param GetRecoveryCapsuleInfo\r
-  Returns the capsule image type and the size of a given image.\r
-\r
-  @param LoadRecoveryCapsule\r
-  Loads a DXE capsule into memory\r
-\r
-**/\r
+///\r
+/// Presents a standard interface to EFI_PEI_DEVICE_RECOVERY_MODULE_PPI,\r
+/// regardless of the underlying device(s).\r
+///\r
 struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI {\r
+  ///\r
+  /// Returns the number of DXE capsules that were found.\r
+  ///\r
   EFI_PEI_DEVICE_GET_NUMBER_RECOVERY_CAPSULE  GetNumberRecoveryCapsules;\r
+  \r
+  ///\r
+  /// Returns the capsule image type and the size of a given image.\r
+  ///\r
   EFI_PEI_DEVICE_GET_RECOVERY_CAPSULE_INFO    GetRecoveryCapsuleInfo;\r
+  \r
+  ///\r
+  /// Loads a DXE capsule into memory\r
+  ///\r
   EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE        LoadRecoveryCapsule;\r
 };\r
 \r
 extern EFI_GUID gEfiPeiDeviceRecoveryModulePpiGuid;\r
 \r
-#endif\r
+#endif  /* _PEI_DEVICE_RECOVERY_MODULE_PPI_H_ */\r