Add doxygen style comments for functions in Partition & Disk IO modules.

[mirror_edk2.git] / MdeModulePkg / Universal / Disk / PartitionDxe / Mbr.c

diff --git a/MdeModulePkg/Universal/Disk/PartitionDxe/Mbr.c b/MdeModulePkg/Universal/Disk/PartitionDxe/Mbr.c
index be63a7e23486a54cea72b2fa4150ee560ef749e6..c95a866e7587ce5612fb2f91669fc305178b1a8b 100644 (file)
--- a/MdeModulePkg/Universal/Disk/PartitionDxe/Mbr.c
+++ b/MdeModulePkg/Universal/Disk/PartitionDxe/Mbr.c
@@ -24,26 +24,22 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "Partition.h"\r
 \r
+/**\r
+  Test to see if the Mbr buffer is a valid MBR.\r
+\r
+  @param  Mbr         Parent Handle.\r
+  @param  LastLba     Last Lba address on the device.\r
+   \r
+  @retval TRUE        Mbr is a Valid MBR.\r
+  @retval FALSE       Mbr is not a Valid MBR.\r
+\r
+**/\r
 STATIC\r
 BOOLEAN\r
 PartitionValidMbr (\r
   IN  MASTER_BOOT_RECORD      *Mbr,\r
   IN  EFI_LBA                 LastLba\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Test to see if the Mbr buffer is a valid MBR\r
-\r
-Arguments:       \r
-  Mbr     - Parent Handle \r
-  LastLba - Last Lba address on the device.\r
-\r
-Returns:\r
-  TRUE  - Mbr is a Valid MBR\r
-  FALSE - Mbr is not a Valid MBR\r
-\r
---*/\r
 {\r
   UINT32  StartingLBA;\r
   UINT32  EndingLBA;\r
@@ -102,6 +98,21 @@ Returns:
   return MbrValid;\r
 }\r
 \r
+\r
+/**\r
+  Install child handles if the Handle supports MBR format.\r
+\r
+  @param  This              Calling context.\r
+  @param  Handle            Parent Handle.\r
+  @param  DiskIo            Parent DiskIo interface.\r
+  @param  BlockIo           Parent BlockIo interface.\r
+  @param  DevicePath        Parent Device Path.\r
+   \r
+  @retval EFI_SUCCESS       A child handle was added.\r
+  @retval EFI_MEDIA_CHANGED Media change was detected.\r
+  @retval Others            MBR partition was not found.\r
+\r
+**/\r
 EFI_STATUS\r
 PartitionInstallMbrChildHandles (\r
   IN  EFI_DRIVER_BINDING_PROTOCOL  *This,\r
@@ -110,24 +121,6 @@ PartitionInstallMbrChildHandles (
   IN  EFI_BLOCK_IO_PROTOCOL        *BlockIo,\r
   IN  EFI_DEVICE_PATH_PROTOCOL     *DevicePath\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Install child handles if the Handle supports MBR format.\r
-\r
-Arguments:       \r
-  This       - Calling context.\r
-  Handle     - Parent Handle \r
-  DiskIo     - Parent DiskIo interface\r
-  BlockIo    - Parent BlockIo interface\r
-  DevicePath - Parent Device Path\r
-\r
-Returns:\r
-  EFI_SUCCESS       - If a child handle was added\r
-  EFI_MEDIA_CHANGED - Media changed Detected\r
-       !EFI_SUCCESS      - Not found MBR partition.\r
-\r
---*/\r
 {\r
   EFI_STATUS                Status;\r
   MASTER_BOOT_RECORD        *Mbr;\r