Add doxygen style comments for functions in DxeIpl.

[mirror_edk2.git] / MdeModulePkg / Core / DxeIplPeim / Ia32 / VirtualMemory.c

diff --git a/MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.c b/MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.c
index 38b242c269c953af0a240fa0aed18280b1ef9175..25fb37ea8e218c8b113fc1cdd5fe476e90743d53 100644 (file)
--- a/MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.c
+++ b/MdeModulePkg/Core/DxeIplPeim/Ia32/VirtualMemory.c
@@ -30,28 +30,26 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include "VirtualMemory.h"\r
 \r
 \r
-UINTN\r
-CreateIdentityMappingPageTables (\r
-  VOID\r
-  )\r
-/*++\r
 \r
-Routine Description:\r
 \r
-  Allocates and fills in the Page Directory and Page Table Entries to\r
-  establish a 1:1 Virtual to Physical mapping.\r
 \r
-Arguments:\r
 \r
-  NumberOfProcessorPhysicalAddressBits - Number of processor address bits to use.\r
-                                         Limits the number of page table entries \r
-                                         to the physical address space.\r
+/**\r
+  Allocates and fills in the Page Directory and Page Table Entries to\r
+  establish a 1:1 Virtual to Physical mapping.\r
 \r
-Returns:\r
+  @param  NumberOfProcessorPhysicalAddressBits  Number of processor address bits \r
+                                                to use. Limits the number of page \r
+                                                table entries  to the physical \r
+                                                address space. \r
 \r
-  EFI_SUCCESS           The 1:1 Virtual to Physical identity mapping was created\r
+  @return EFI_SUCCESS           The 1:1 Virtual to Physical identity mapping was created\r
 \r
---*/\r
+**/\r
+UINTN\r
+CreateIdentityMappingPageTables (\r
+  VOID\r
+  )\r
 {  \r
   UINT8                                         PhysicalAddressBits;\r
   EFI_PHYSICAL_ADDRESS                          PageAddress;\r
@@ -159,6 +157,6 @@ Returns:
        );\r
   }\r
 \r
-  return (UINTN)PageMap; // FIXME\r
+  return (UINTN)PageMap;\r
 }\r
 \r