Add doxygen style comments for functions in DxeMain.

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / FwVol / FwVolAttrib.c

diff --git a/MdeModulePkg/Core/Dxe/FwVol/FwVolAttrib.c b/MdeModulePkg/Core/Dxe/FwVol/FwVolAttrib.c
index 54abc0bfd652398bc3307b4ff1b9ae0d505470e5..8b637e82ceba74c2577f3e65042b8023287322ca 100644 (file)
--- a/MdeModulePkg/Core/Dxe/FwVol/FwVolAttrib.c
+++ b/MdeModulePkg/Core/Dxe/FwVol/FwVolAttrib.c
@@ -15,26 +15,23 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include <DxeMain.h>\r
 \r
+\r
+/**\r
+  Retrieves attributes, insures positive polarity of attribute bits, returns\r
+  resulting attributes in output parameter.\r
+\r
+  @param  This             Calling context \r
+  @param  Attributes       output buffer which contains attributes \r
+\r
+  @retval EFI_SUCCESS      Successfully got volume attributes\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 FvGetVolumeAttributes (\r
   IN  CONST EFI_FIRMWARE_VOLUME2_PROTOCOL *This,\r
   OUT       EFI_FV_ATTRIBUTES             *Attributes\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-    Retrieves attributes, insures positive polarity of attribute bits, returns\r
-    resulting attributes in output parameter\r
-\r
-Arguments:\r
-    This        - Calling context\r
-    Attributes  - output buffer which contains attributes\r
-\r
-Returns:\r
-    EFI_SUCCESS         - Successfully got volume attributes\r
-\r
---*/\r
 {\r
   EFI_STATUS                                Status;\r
   FV_DEVICE                                 *FvDevice;\r
@@ -67,30 +64,41 @@ Returns:
 }\r
 \r
 \r
+\r
+/**\r
+  Sets current attributes for volume\r
+\r
+  @param  This             Calling context \r
+  @param  Attributes       At input, contains attributes to be set.  At output \r
+                           contains new value of FV \r
+\r
+  @retval EFI_UNSUPPORTED  Could not be set.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 FvSetVolumeAttributes (\r
   IN     CONST EFI_FIRMWARE_VOLUME2_PROTOCOL  *This,\r
   IN OUT       EFI_FV_ATTRIBUTES              *Attributes\r
   )\r
-/*++\r
+{\r
+  return EFI_UNSUPPORTED;\r
+}\r
 \r
-Routine Description:\r
-    Sets current attributes for volume\r
 \r
-Arguments:\r
-    This       - Calling context\r
-    Attributes - At input, contains attributes to be set.  At output contains\r
-      new value of FV\r
+/**\r
+  Return information of type InformationType for the requested firmware\r
+  volume.\r
 \r
-Returns:\r
-    EFI_UNSUPPORTED   - Could not be set.\r
+  @param  This             Pointer to EFI_FIRMWARE_VOLUME2_PROTOCOL. \r
+  @param  InformationType  InformationType for requested. \r
+  @param  BufferSize       On input, size of Buffer.On output, the amount of data \r
+                           returned in Buffer. \r
+  @param  Buffer           A poniter to the data buffer to return. \r
 \r
---*/\r
-{\r
-  return EFI_UNSUPPORTED;\r
-}\r
+  @retval EFI_SUCCESS      Successfully got volume Information.\r
 \r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 FvGetVolumeInfo (\r
@@ -99,27 +107,25 @@ FvGetVolumeInfo (
   IN OUT UINTN                                  *BufferSize,\r
   OUT VOID                                      *Buffer\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Return information of type InformationType for the requested firmware\r
-  volume.\r
-  \r
-Arguments:\r
-    This                - Pointer to EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
-    InformationType     - InformationType for requested.\r
-    BufferSize          - On input, size of Buffer.On output, the amount of\r
-                          data returned in Buffer.\r
-    Buffer              - A poniter to the data buffer to return.\r
-Returns:\r
-    EFI_SUCCESS         - Successfully got volume Information.\r
-\r
---*/\r
 {\r
   return EFI_UNSUPPORTED;\r
 }\r
 \r
 \r
+\r
+/**\r
+  Set information of type InformationType for the requested firmware\r
+  volume.\r
+\r
+  @param  This             Pointer to EFI_FIRMWARE_VOLUME2_PROTOCOL. \r
+  @param  InformationType  InformationType for requested. \r
+  @param  BufferSize       On input, size of Buffer.On output, the amount of data \r
+                           returned in Buffer. \r
+  @param  Buffer           A poniter to the data buffer to return. \r
+\r
+  @retval EFI_SUCCESS      Successfully set volume Information.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 FvSetVolumeInfo (\r
@@ -128,24 +134,9 @@ FvSetVolumeInfo (
   IN  UINTN                                     BufferSize,\r
   IN CONST  VOID                                *Buffer\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Set information of type InformationType for the requested firmware\r
-  volume.\r
-\r
-Arguments:\r
-    This                - Pointer to EFI_FIRMWARE_VOLUME2_PROTOCOL.\r
-    InformationType     - InformationType for requested.\r
-    BufferSize          - On input, size of Buffer.On output, the amount of\r
-                          data returned in Buffer.\r
-    Buffer              - A poniter to the data buffer to return.\r
-Returns:\r
-    EFI_SUCCESS         - Successfully set volume Information.\r
-\r
---*/\r
 {\r
   return EFI_UNSUPPORTED;\r
 }\r
 \r
 \r
+\r