Add doxygen style comments for functions in DxeMain.

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

diff --git a/MdeModulePkg/Core/Dxe/imem.h b/MdeModulePkg/Core/Dxe/imem.h
index a9df0ba5b0b52b344692250077fd6a9a13c20dd1..0caaa4303e9bcfb306154a679ba7c7bd80162c13 100644 (file)
--- a/MdeModulePkg/Core/Dxe/imem.h
+++ b/MdeModulePkg/Core/Dxe/imem.h
@@ -11,7 +11,8 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
---*/\r
+\r
+**/\r
 \r
 #ifndef _IMEM_H_\r
 #define _IMEM_H_\r
@@ -55,155 +56,100 @@ typedef struct {
 // Internal prototypes\r
 //\r
 \r
-VOID *\r
-CoreAllocatePoolPages (\r
-  IN EFI_MEMORY_TYPE   PoolType,\r
-  IN UINTN             NumberOfPages,\r
-  IN UINTN             Alignment\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
 \r
+/**\r
   Internal function.  Used by the pool functions to allocate pages\r
   to back pool allocation requests.\r
 \r
-Arguments:\r
+  @param  PoolType               The type of memory for the new pool pages \r
+  @param  NumberOfPages          No of pages to allocate \r
+  @param  Alignment              Bits to align. \r
 \r
-  PoolType      - The type of memory for the new pool pages\r
+  @return The allocated memory, or NULL\r
 \r
-  NumberOfPages - No of pages to allocate\r
-  \r
-  Alignment     - Bits to align.\r
+**/\r
+VOID *\r
+CoreAllocatePoolPages (\r
+  IN EFI_MEMORY_TYPE   PoolType,\r
+  IN UINTN             NumberOfPages,\r
+  IN UINTN             Alignment\r
+  )\r
+;\r
 \r
-Returns:\r
 \r
-  The allocated memory, or NULL\r
 \r
---*/\r
-;\r
+/**\r
+  Internal function.  Frees pool pages allocated via AllocatePoolPages ()\r
 \r
+  @param  Memory                 The base address to free \r
+  @param  NumberOfPages          The number of pages to free\r
 \r
+**/\r
 VOID\r
 CoreFreePoolPages (\r
   IN EFI_PHYSICAL_ADDRESS   Memory,\r
   IN UINTN                  NumberOfPages\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Internal function.  Frees pool pages allocated via AllocatePoolPages ()\r
-\r
-Arguments:\r
-\r
-  Memory        - The base address to free\r
+;\r
 \r
-  NumberOfPages - The number of pages to free\r
 \r
-Returns:\r
 \r
-  None\r
+/**\r
+  Internal function to allocate pool of a particular type.\r
+  Caller must have the memory lock held\r
 \r
---*/\r
-;\r
+  @param  PoolType               Type of pool to allocate \r
+  @param  Size                   The amount of pool to allocate \r
 \r
+  @return The allocate pool, or NULL\r
 \r
+**/\r
 VOID *\r
 CoreAllocatePoolI (\r
   IN EFI_MEMORY_TYPE  PoolType,\r
   IN UINTN            Size\r
   )\r
-/*++\r
+;\r
 \r
-Routine Description:\r
 \r
-  Internal function to allocate pool of a particular type.\r
 \r
+/**\r
+  Internal function to free a pool entry.\r
   Caller must have the memory lock held\r
 \r
+  @param  Buffer                 The allocated pool entry to free \r
 \r
-Arguments:\r
-\r
-  PoolType    - Type of pool to allocate\r
-\r
-  Size        - The amount of pool to allocate\r
-\r
-Returns:\r
-\r
-  The allocate pool, or NULL\r
-\r
---*/\r
-;\r
-\r
+  @retval EFI_INVALID_PARAMETER  Buffer not valid \r
+  @retval EFI_SUCCESS            Buffer successfully freed.\r
 \r
+**/\r
 EFI_STATUS\r
 CoreFreePoolI (\r
   IN VOID           *Buffer\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Internal function to free a pool entry.\r
-\r
-  Caller must have the memory lock held\r
-\r
-\r
-Arguments:\r
-\r
-  Buffer      - The allocated pool entry to free\r
+;\r
 \r
-Returns:\r
 \r
-  EFI_INVALID_PARAMETER     - Buffer not valid\r
-  \r
-  EFI_SUCCESS               - Buffer successfully freed.\r
-\r
---*/\r
-;\r
 \r
+/**\r
+  Enter critical section by gaining lock on gMemoryLock.\r
 \r
+**/\r
 VOID\r
 CoreAcquireMemoryLock (\r
   VOID\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Enter critical section by gaining lock on gMemoryLock\r
-\r
-Arguments:\r
-\r
-  None\r
-\r
-Returns:\r
+;\r
 \r
-  None\r
 \r
---*/\r
-;\r
+/**\r
+  Exit critical section by releasing lock on gMemoryLock.\r
 \r
+**/\r
 VOID\r
 CoreReleaseMemoryLock (\r
   VOID\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Exit critical section by releasing lock on gMemoryLock\r
-\r
-Arguments:\r
-\r
-  None\r
-\r
-Returns:\r
-\r
-  None\r
-\r
---*/\r
 ;\r
 \r
 \r