Add doxygen style comments for functions in DxeMain.

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / Misc / InstallConfigurationTable.c

diff --git a/MdeModulePkg/Core/Dxe/Misc/InstallConfigurationTable.c b/MdeModulePkg/Core/Dxe/Misc/InstallConfigurationTable.c
index 26db2fbc1f4978837fcbce19d33cef02aaa255eb..95d0393a8419db22d3fb13f4da18c75d8fe8fb17 100644 (file)
--- a/MdeModulePkg/Core/Dxe/Misc/InstallConfigurationTable.c
+++ b/MdeModulePkg/Core/Dxe/Misc/InstallConfigurationTable.c
@@ -20,30 +20,23 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 UINTN mSystemTableAllocateSize = 0;\r
 \r
 \r
-EFI_STATUS\r
-CoreGetConfigTable (\r
-  IN EFI_GUID *Guid,\r
-  OUT VOID    **Table\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
 \r
+/**\r
   Find a config table by name in system table's ConfigurationTable.\r
 \r
-Arguments:\r
-\r
-  Guid        - The table name to look for\r
-  \r
-  Table       - Pointer of the config table\r
+  @param  Guid           The table name to look for \r
+  @param  Table          Pointer of the config table \r
 \r
-Returns: \r
+  @retval EFI_NOT_FOUND  Could not find the table in system table's \r
+                         ConfigurationTable. \r
+  @retval EFI_SUCCESS    Table successfully found.\r
 \r
-  EFI_NOT_FOUND       - Could not find the table in system table's ConfigurationTable.\r
-  \r
-  EFI_SUCCESS         - Table successfully found.\r
-\r
---*/\r
+**/\r
+EFI_STATUS\r
+CoreGetConfigTable (\r
+  IN EFI_GUID *Guid,\r
+  OUT VOID    **Table\r
+  )\r
 {\r
   UINTN Index;\r
 \r
@@ -59,33 +52,28 @@ Returns:
 \r
 \r
 \r
+\r
+/**\r
+  Boot Service called to add, modify, or remove a system configuration table from\r
+  the EFI System Table.\r
+\r
+  @param  Guid           Pointer to the GUID for the entry to add, update, or \r
+                         remove \r
+  @param  Table          Pointer to the configuration table for the entry to add, \r
+                         update, or remove, may be NULL. \r
+\r
+  @return EFI_SUCCESS               Guid, Table pair added, updated, or removed.\r
+  @return EFI_INVALID_PARAMETER     Input GUID not valid.\r
+  @return EFI_NOT_FOUND             Attempted to delete non-existant entry\r
+  @return EFI_OUT_OF_RESOURCES      Not enough memory available\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 CoreInstallConfigurationTable (\r
   IN EFI_GUID *Guid,\r
   IN VOID     *Table\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Boot Service called to add, modify, or remove a system configuration table from \r
-  the EFI System Table.\r
-\r
-Arguments:\r
-\r
-  Guid     -  Pointer to the GUID for the entry to add, update, or remove\r
-  Table    -  Pointer to the configuration table for the entry to add, update, or\r
-              remove, may be NULL.\r
-\r
-Returns:\r
-  \r
-  EFI_SUCCESS               Guid, Table pair added, updated, or removed.\r
-  EFI_INVALID_PARAMETER     Input GUID not valid.\r
-  EFI_NOT_FOUND             Attempted to delete non-existant entry\r
-  EFI_OUT_OF_RESOURCES      Not enough memory available\r
-\r
---*/\r
 {\r
   UINTN                   Index;\r
   EFI_CONFIGURATION_TABLE *EfiConfigurationTable;\r