Formalize comments for Protocols and PPIs.

[mirror_edk2.git] / MdePkg / Include / Protocol / FirmwareVolume2.h

diff --git a/MdePkg/Include/Protocol/FirmwareVolume2.h b/MdePkg/Include/Protocol/FirmwareVolume2.h
index 5961c8b74126f30eb76b9eaa2524d5b5d955e3dd..0d5e5481fbd1c3fb38fbe225b49cc85db9ea4c81 100644 (file)
--- a/MdePkg/Include/Protocol/FirmwareVolume2.h
+++ b/MdePkg/Include/Protocol/FirmwareVolume2.h
@@ -85,7 +85,8 @@ typedef UINT64  EFI_FV_ATTRIBUTES;
 #define EFI_FV2_ALIGNMENT_2G            0x00000000001F0000ULL\r
 \r
 /**\r
-  \r
+  Returns the attributes and current settings of the firmware volume.\r
+\r
   Because of constraints imposed by the underlying firmware\r
   storage, an instance of the Firmware Volume Protocol may not\r
   be to able to support all possible variations of this\r
@@ -116,6 +117,8 @@ EFI_STATUS
 \r
 \r
 /**\r
+  Modifies the current settings of the firmware volume according to the input parameter.\r
+  \r
   The SetVolumeAttributes() function is used to set configurable\r
   firmware volume attributes. Only EFI_FV_READ_STATUS,\r
   EFI_FV_WRITE_STATUS, and EFI_FV_LOCK_STATUS may be modified, and\r
@@ -209,11 +212,13 @@ EFI_STATUS
 \r
 \r
 /**\r
+  Retrieves a file and/or file information from the firmware volume.\r
+\r
   ReadFile() is used to retrieve any file from a firmware volume\r
   during the DXE phase. The actual binary encoding of the file in\r
   the firmware volume media may be in any arbitrary format as long\r
-  as it does the following: ?It is accessed using the Firmware\r
-  Volume Protocol. ?The image that is returned follows the image\r
+  as it does the following: It is accessed using the Firmware\r
+  Volume Protocol. The image that is returned follows the image\r
   format defined in Code Definitions: PI Firmware File Format.\r
   If the input value of Buffer==NULL, it indicates the caller is\r
   requesting only that the type, attributes, and size of the\r
@@ -308,12 +313,12 @@ EFI_STATUS
 \r
 \r
 /**\r
+  Locates the requested section within a file and returns it in a buffer.\r
+\r
   ReadSection() is used to retrieve a specific section from a file\r
   within a firmware volume. The section returned is determined\r
   using a depth-first, left-to-right search algorithm through all\r
-  sections found in the specified file. See\r
-   ????Firmware File Sections???? on page 9 for more details about\r
-  sections. The output buffer is specified by a double indirection\r
+  sections found in the specified file. The output buffer is specified by a double indirection\r
   of the Buffer parameter. The input value of Buffer is used to\r
   determine if the output buffer is caller allocated or is\r
   dynamically allocated by ReadSection(). If the input value of\r
@@ -432,6 +437,8 @@ typedef struct {
 } EFI_FV_WRITE_FILE_DATA;\r
 \r
 /**\r
+  Locates the requested section within a file and returns it in a buffer.\r
+\r
   WriteFile() is used to write one or more files to a firmware\r
   volume. Each file to be written is described by an\r
   EFI_FV_WRITE_FILE_DATA structure. The caller must ensure that\r
@@ -506,6 +513,9 @@ EFI_STATUS
 \r
 \r
 /**\r
+       Retrieves information about the next file in the firmware volume store \r
+       that matches the search criteria.\r
+\r
   GetNextFile() is the interface that is used to search a firmware\r
   volume for a particular file. It is called successively until\r
   the desired file is located or the function returns\r
@@ -589,6 +599,8 @@ EFI_STATUS
 );\r
 \r
 /**\r
+  Return information about a firmware volume.\r
+\r
   The GetInfo() function returns information of type\r
   InformationType for the requested firmware volume. If the volume\r
   does not support the requested information type, then\r
@@ -644,6 +656,7 @@ EFI_STATUS
 \r
 \r
 /**\r
+  Sets information about a firmware volume.\r
 \r
   The SetInfo() function sets information of type InformationType\r
   on the requested firmware volume.\r
@@ -692,20 +705,19 @@ EFI_STATUS
 );\r
 \r
 \r
-/**\r
-  @par Protocol Description:\r
-  The Firmware Volume Protocol contains the file-level\r
-  abstraction to the firmware volume as well as some firmware\r
-  volume attribute reporting and configuration services. The\r
-  Firmware Volume Protocol is the interface used by all parts of\r
-  DXE that are not directly involved with managing the firmware\r
-  volume itself. This abstraction allows many varied types of\r
-  firmware volume implementations. A firmware volume may be a\r
-  flash device or it may be a file in the UEFI system partition,\r
-  for example. This level of firmware volume implementation\r
-  detail is not visible to the consumers of the Firmware Volume\r
-  Protocol.\r
-**/\r
+///\r
+/// The Firmware Volume Protocol contains the file-level\r
+/// abstraction to the firmware volume as well as some firmware\r
+/// volume attribute reporting and configuration services. The\r
+/// Firmware Volume Protocol is the interface used by all parts of\r
+/// DXE that are not directly involved with managing the firmware\r
+/// volume itself. This abstraction allows many varied types of\r
+/// firmware volume implementations. A firmware volume may be a\r
+/// flash device or it may be a file in the UEFI system partition,\r
+/// for example. This level of firmware volume implementation\r
+/// detail is not visible to the consumers of the Firmware Volume\r
+/// Protocol.\r
+///\r
 struct _EFI_FIRMWARE_VOLUME2_PROTOCOL {\r
   EFI_FV_GET_ATTRIBUTES   GetVolumeAttributes;\r
   EFI_FV_SET_ATTRIBUTES   SetVolumeAttributes;\r