Adjust syntax of comment contents.

Document members of the Device Recovery Module PPI.

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

diff --git a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
index 7847b51079420afd08c31d5dec533e65e3532297..b59726f19ea80944554dd8b40e00687339cbf293 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
+++ b/IntelFrameworkPkg/Include/Ppi/DeviceRecoveryModule.h
@@ -1,12 +1,14 @@
 /** @file\r
-  This file declares Device Recovery Module PPI.\r
+  This file declares the Device Recovery Module PPI.\r
+\r
   The interface of this PPI does the following:\r
     - Reports the number of recovery DXE capsules that exist on the associated device(s)\r
     - Finds the requested firmware binary capsule\r
     - Loads that capsule into memory\r
-  A device can be either a group of devices, such as a block device, or an individual device.T he\r
-  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
+  A device can be either a group of devices, such as a block device, or an individual device.\r
+  The module determines the internal search order, with capsule number 1 as the highest load\r
+  priority and number N as the lowest priority.\r
 \r
   Copyright (c) 2007 - 2009, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
@@ -18,7 +20,7 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
   @par Revision Reference:\r
-  This PPI is defined in Framework of EFI Recovery spec.\r
+  This PPI is defined in the "EFI Recovery" Framework spec.\r
   Version 0.9\r
 \r
 **/\r
@@ -122,9 +124,9 @@ EFI_STATUS
 /// regardless of the underlying device(s).\r
 ///\r
 struct _EFI_PEI_DEVICE_RECOVERY_MODULE_PPI {\r
-  EFI_PEI_DEVICE_GET_NUMBER_RECOVERY_CAPSULE  GetNumberRecoveryCapsules;\r
-  EFI_PEI_DEVICE_GET_RECOVERY_CAPSULE_INFO    GetRecoveryCapsuleInfo;\r
-  EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE        LoadRecoveryCapsule;\r
+  EFI_PEI_DEVICE_GET_NUMBER_RECOVERY_CAPSULE  GetNumberRecoveryCapsules;    ///< Returns the number of DXE capsules residing on the device.\r
+  EFI_PEI_DEVICE_GET_RECOVERY_CAPSULE_INFO    GetRecoveryCapsuleInfo;       ///< Returns the size and type of the requested recovery capsule.\r
+  EFI_PEI_DEVICE_LOAD_RECOVERY_CAPSULE        LoadRecoveryCapsule;          ///< Loads a DXE capsule from some media into memory.\r
 };\r
 \r
 extern EFI_GUID gEfiPeiDeviceRecoveryModulePpiGuid;\r