diff options
| author | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2006-07-20 09:08:37 +0000 |
|---|---|---|
| committer | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2006-07-20 09:08:37 +0000 |
| commit | 0647c9adf92c6a8712091607a73b2768327a865d (patch) | |
| tree | 41c00f087dea23a35388100f5b9895753555ac3c /MdePkg/Include/Ppi/DeviceRecoveryModule.h | |
| parent | 151c1ccdcd6960c550fa491bd0ed467416bb2b74 (diff) | |
| download | edk2-platforms-0647c9adf92c6a8712091607a73b2768327a865d.tar.xz | |
Remove BugBug in comments and adjust function header according to code style doc.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1055 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Ppi/DeviceRecoveryModule.h')
| -rw-r--r-- | MdePkg/Include/Ppi/DeviceRecoveryModule.h | 68 |
1 files changed, 27 insertions, 41 deletions
diff --git a/MdePkg/Include/Ppi/DeviceRecoveryModule.h b/MdePkg/Include/Ppi/DeviceRecoveryModule.h index 3847686b04..46c5cdeaae 100644 --- 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
and entry N is assumed to be the lowest priority.
- @param PeiServices General-purpose services that are available to every PEIM
-
- @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
-
- @param NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On output,
- *NumberRecoveryCapsules contains the number of recovery capsule images available
- for retrieval from this PEIM instance.
-
- @retval EFI_SUCCESS One or more capsules were discovered.
-
- @retval EFI_DEVICE_ERROR A device error occurred.
-
- @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
+ @param PeiServices General-purpose services that are available to every PEIM
+ @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
+ @param NumberRecoveryCapsules Pointer to a caller-allocated UINTN. On output,
+ *NumberRecoveryCapsules contains the number of recovery capsule
+ images available for retrieval from this PEIM instance.
+
+ @retval EFI_SUCCESS One or more capsules were discovered.
+ @retval EFI_DEVICE_ERROR A device error occurred.
+ @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
**/
typedef
@@ -60,23 +56,17 @@ EFI_STATUS /**
This function gets the size and type of the requested recovery capsule.
- @param PeiServices General-purpose services that are available to every PEIM
-
- @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
-
+ @param PeiServices General-purpose services that are available to every PEIM
+ @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
@param CapsuleInstance Specifies for which capsule instance to retrieve the information.
-
- @param Size A pointer to a caller-allocated UINTN in which the size of
- the requested recovery module is returned.
-
- @param CapsuleType A pointer to a caller-allocated EFI_GUID in
- which the type of the requested recovery capsule is returned.
-
- @retval EFI_SUCCESS One or more capsules were discovered.
-
- @retval EFI_DEVICE_ERROR A device error occurred.
-
- @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
+ @param Size A pointer to a caller-allocated UINTN in which the size of
+ the requested recovery module is returned.
+ @param CapsuleType A pointer to a caller-allocated EFI_GUID in
+ which the type of the requested recovery capsule is returned.
+
+ @retval EFI_SUCCESS One or more capsules were discovered.
+ @retval EFI_DEVICE_ERROR A device error occurred.
+ @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
**/
typedef
@@ -93,19 +83,15 @@ EFI_STATUS This function, by whatever mechanism, retrieves a DXE capsule from some device
and loads it into memory. Note that the published interface is device neutral.
- @param PeiServices General-purpose services that are available to every PEIM
-
- @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
-
+ @param PeiServices General-purpose services that are available to every PEIM
+ @param This Indicates the EFI_PEI_DEVICE_RECOVERY_MODULE_PPI instance.
@param CapsuleInstance Specifies which capsule instance to retrieve.
-
- @param Buffer Specifies a caller-allocated buffer in which the requested recovery capsule will be returned.
-
- @retval EFI_SUCCESS One or more capsules were discovered.
-
- @retval EFI_DEVICE_ERROR A device error occurred.
-
- @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
+ @param Buffer Specifies a caller-allocated buffer in which the requested
+ recovery capsule will be returned.
+
+ @retval EFI_SUCCESS One or more capsules were discovered.
+ @retval EFI_DEVICE_ERROR A device error occurred.
+ @retval EFI_NOT_FOUND A recovery DXE capsule cannot be found.
**/
typedef
|