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

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

diff --git a/MdeModulePkg/Universal/Disk/PartitionDxe/Gpt.c b/MdeModulePkg/Universal/Disk/PartitionDxe/Gpt.c
index 56245ec7ae839f4da5e9350bdc05a392248a8d6c..ef3c766e536ecfcdf0cab564965e6d417a5e5808 100644 (file)
--- a/MdeModulePkg/Universal/Disk/PartitionDxe/Gpt.c
+++ b/MdeModulePkg/Universal/Disk/PartitionDxe/Gpt.c
@@ -17,6 +17,18 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include "Partition.h"\r
 \r
 \r
+/**\r
+  Install child handles if the Handle supports GPT partition structure.\r
+\r
+  @param[in]  BlockIo     Parent BlockIo interface\r
+  @param[in]  DiskIo      Disk Io protocol.\r
+  @param[in]  Lba         The starting Lba of the Partition Table\r
+  @param[out] PartHeader  Stores the partition table that is read\r
+\r
+  @retval TRUE      The partition table is valid\r
+  @retval FALSE     The partition table is not valid\r
+\r
+**/\r
 BOOLEAN\r
 PartitionValidGptTable (\r
   IN  EFI_BLOCK_IO_PROTOCOL       *BlockIo,\r
@@ -26,6 +38,18 @@ PartitionValidGptTable (
   );\r
 \r
 \r
+/**\r
+  Check if the CRC field in the Partition table header is valid\r
+  for Partition entry array.\r
+\r
+  @param[in]  BlockIo     Parent BlockIo interface\r
+  @param[in]  DiskIo      Disk Io Protocol.\r
+  @param[in]  PartHeader  Partition table header structure\r
+\r
+  @retval TRUE      the CRC is valid\r
+  @retval FALSE     the CRC is invalid\r
+\r
+**/\r
 BOOLEAN\r
 PartitionCheckGptEntryArrayCRC (\r
   IN  EFI_BLOCK_IO_PROTOCOL       *BlockIo,\r
@@ -34,6 +58,18 @@ PartitionCheckGptEntryArrayCRC (
   );\r
 \r
 \r
+/**\r
+  Restore Partition Table to its alternate place\r
+  (Primary -> Backup or Backup -> Primary)\r
+\r
+  @param[in]  BlockIo     Parent BlockIo interface\r
+  @param[in]  DiskIo      Disk Io Protocol.\r
+  @param[in]  PartHeader  Partition table header structure\r
+\r
+  @retval TRUE      Restoring succeeds\r
+  @retval FALSE     Restoring failed\r
+\r
+**/\r
 BOOLEAN\r
 PartitionRestoreGptTable (\r
   IN  EFI_BLOCK_IO_PROTOCOL       *BlockIo,\r
@@ -42,6 +78,16 @@ PartitionRestoreGptTable (
   );\r
 \r
 \r
+/**\r
+  Restore Partition Table to its alternate place\r
+  (Primary -> Backup or Backup -> Primary)\r
+\r
+  @param[in]    PartHeader    Partition table header structure\r
+  @param[in]    PartEntry     The partition entry array\r
+  @param[out]   PEntryStatus  the partition entry status array \r
+                              recording the status of each partition\r
+\r
+**/\r
 VOID\r
 PartitionCheckGptEntry (\r
   IN  EFI_PARTITION_TABLE_HEADER  *PartHeader,\r
@@ -50,6 +96,17 @@ PartitionCheckGptEntry (
   );\r
 \r
 \r
+/**\r
+  Checks the CRC32 value in the table header\r
+\r
+  @param  MaxSize   Max Size limit\r
+  @param  Size      The size of the table\r
+  @param  Hdr       Table to check\r
+\r
+  @return TRUE    CRC Valid\r
+  @return FALSE   CRC Invalid\r
+\r
+**/\r
 BOOLEAN\r
 PartitionCheckCrcAltSize (\r
   IN UINTN                 MaxSize,\r
@@ -58,6 +115,16 @@ PartitionCheckCrcAltSize (
   );\r
 \r
 \r
+/**\r
+  Checks the CRC32 value in the table header\r
+\r
+  @param  MaxSize   Max Size limit\r
+  @param  Hdr       Table to check\r
+\r
+  @return TRUE      CRC Valid\r
+  @return FALSE     CRC Invalid\r
+\r
+**/\r
 BOOLEAN\r
 PartitionCheckCrc (\r
   IN UINTN                 MaxSize,\r
@@ -65,6 +132,13 @@ PartitionCheckCrc (
   );\r
 \r
 \r
+/**\r
+  Updates the CRC32 value in the table header\r
+\r
+  @param  Size   The size of the table\r
+  @param  Hdr    Table to update\r
+\r
+**/\r
 VOID\r
 PartitionSetCrcAltSize (\r
   IN UINTN                 Size,\r
@@ -72,6 +146,12 @@ PartitionSetCrcAltSize (
   );\r
 \r
 \r
+/**\r
+  Updates the CRC32 value in the table header\r
+\r
+  @param  Hdr    Table to update\r
+\r
+**/\r
 VOID\r
 PartitionSetCrc (\r
   IN OUT EFI_TABLE_HEADER *Hdr\r
@@ -325,7 +405,7 @@ Done:
   @param[in]  BlockIo     Parent BlockIo interface\r
   @param[in]  DiskIo      Disk Io protocol.\r
   @param[in]  Lba         The starting Lba of the Partition Table\r
-  @param[in]  PartHeader  Stores the partition table that is read\r
+  @param[out] PartHeader  Stores the partition table that is read\r
 \r
   @retval TRUE      The partition table is valid\r
   @retval FALSE     The partition table is not valid\r
@@ -546,6 +626,7 @@ Done:
   @param[in]    PartEntry     The partition entry array\r
   @param[out]   PEntryStatus  the partition entry status array \r
                               recording the status of each partition\r
+\r
 **/\r
 VOID\r
 PartitionCheckGptEntry (\r
@@ -602,7 +683,7 @@ PartitionCheckGptEntry (
 /**\r
   Updates the CRC32 value in the table header\r
 \r
-  @param[in,out]  Hdr    Table to update\r
+  @param  Hdr    Table to update\r
 \r
 **/\r
 VOID\r
@@ -617,8 +698,8 @@ PartitionSetCrc (
 /**\r
   Updates the CRC32 value in the table header\r
 \r
-  @param[in]      Size   The size of the table\r
-  @param[in,out]  Hdr    Table to update\r
+  @param  Size   The size of the table\r
+  @param  Hdr    Table to update\r
 \r
 **/\r
 VOID\r
@@ -639,11 +720,11 @@ PartitionSetCrcAltSize (
 /**\r
   Checks the CRC32 value in the table header\r
 \r
-  @param[in]      MaxSize   Max Size limit\r
-  @param[in,out]  Hdr       Table to check\r
+  @param  MaxSize   Max Size limit\r
+  @param  Hdr       Table to check\r
 \r
-  @return TRUE    CRC Valid\r
-  @return FALSE   CRC Invalid\r
+  @return TRUE      CRC Valid\r
+  @return FALSE     CRC Invalid\r
 \r
 **/\r
 BOOLEAN\r
@@ -659,9 +740,9 @@ PartitionCheckCrc (
 /**\r
   Checks the CRC32 value in the table header\r
 \r
-  @param[in]      MaxSize   Max Size limit\r
-  @param[in]      Size      The size of the table\r
-  @param[in,out]  Hdr       Table to check\r
+  @param  MaxSize   Max Size limit\r
+  @param  Size      The size of the table\r
+  @param  Hdr       Table to check\r
 \r
   @return TRUE    CRC Valid\r
   @return FALSE   CRC Invalid\r