Add doxygen style comments for functions in DxeMain.

[mirror_edk2.git] / MdeModulePkg / Core / Dxe / DebugImageInfo.h

diff --git a/MdeModulePkg/Core/Dxe/DebugImageInfo.h b/MdeModulePkg/Core/Dxe/DebugImageInfo.h
index 5f05a90a5258e2281d97937cf992c85f49c38865..26a5bb185c631b631a2b8369d8a216746b5fba73 100644 (file)
--- a/MdeModulePkg/Core/Dxe/DebugImageInfo.h
+++ b/MdeModulePkg/Core/Dxe/DebugImageInfo.h
@@ -22,99 +22,69 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #define EFI_DEBUG_TABLE_ENTRY_SIZE       (sizeof (VOID *))\r
 \r
-VOID\r
-CoreInitializeDebugImageInfoTable (\r
-  VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
 \r
+/**\r
   Creates and initializes the DebugImageInfo Table.  Also creates the configuration\r
   table and registers it into the system table.\r
 \r
-Arguments:\r
-  None\r
-\r
-Returns:\r
-  NA\r
-\r
-Notes:\r
-  This function allocates memory, frees it, and then allocates memory at an\r
-  address within the initial allocation. Since this function is called early\r
-  in DXE core initialization (before drivers are dispatched), this should not\r
-  be a problem.\r
-\r
---*/\r
-;\r
+  Note:\r
+    This function allocates memory, frees it, and then allocates memory at an\r
+    address within the initial allocation. Since this function is called early\r
+    in DXE core initialization (before drivers are dispatched), this should not\r
+    be a problem.\r
 \r
+**/\r
 VOID\r
-CoreUpdateDebugTableCrc32 (\r
+CoreInitializeDebugImageInfoTable (\r
   VOID\r
   )\r
-/*++\r
+;\r
 \r
-Routine Description:\r
 \r
+/**\r
   Update the CRC32 in the Debug Table.\r
   Since the CRC32 service is made available by the Runtime driver, we have to\r
   wait for the Runtime Driver to be installed before the CRC32 can be computed.\r
   This function is called elsewhere by the core when the runtime architectural\r
   protocol is produced.\r
 \r
-Arguments:\r
-  None\r
+**/\r
+VOID\r
+CoreUpdateDebugTableCrc32 (\r
+  VOID\r
+  )\r
+;\r
 \r
-Returns:\r
-  NA\r
 \r
---*/\r
-;\r
+/**\r
+  Adds a new DebugImageInfo structure to the DebugImageInfo Table.  Re-Allocates\r
+  the table if it's not large enough to accomidate another entry.\r
+\r
+  @param  ImageInfoType  type of debug image information \r
+  @param  LoadedImage    pointer to the loaded image protocol for the image being \r
+                         loaded \r
+  @param  ImageHandle    image handle for the image being loaded\r
 \r
+**/\r
 VOID\r
 CoreNewDebugImageInfoEntry (\r
   UINT32                    ImageInfoType,\r
   EFI_LOADED_IMAGE_PROTOCOL *LoadedImage,\r
   EFI_HANDLE                ImageHandle\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Adds a new DebugImageInfo structure to the DebugImageInfo Table.  Re-Allocates\r
-  the table if it's not large enough to accomidate another entry.\r
-\r
-Arguments:\r
+;\r
 \r
-  ImageInfoType     - type of debug image information\r
-  LoadedImage       - pointer to the loaded image protocol for the image being loaded\r
-  ImageHandle       - image handle for the image being loaded\r
 \r
-Returns:\r
-  NA\r
+/**\r
+  Removes and frees an entry from the DebugImageInfo Table.\r
 \r
---*/\r
-;\r
+  @param  ImageHandle    image handle for the image being unloaded\r
 \r
+**/\r
 VOID\r
 CoreRemoveDebugImageInfoEntry (\r
   EFI_HANDLE ImageHandle\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Removes and frees an entry from the DebugImageInfo Table.\r
-\r
-Arguments:\r
-\r
-  ImageHandle       - image handle for the image being unloaded\r
-\r
-Returns:\r
-\r
-  NA\r
-\r
---*/\r
 ;\r
 \r
 #endif\r