MdeModulePkg/DxeIplPeim: Refine coding style in function comments

Make the comments align with the function.
And add some missing function comments.

Cc: Jian J Wang <jian.j.wang@intel.com>
Cc: Eric Dong <eric.dong@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Jian J Wang <jian.j.wang@intel.com>

diff --git a/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h b/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
index ecf186667a1c03375ab40a1f9a89f704377ef937..f3aabdb7e0f02b2bde79f0d3ea848ef751bc0f5f 100644 (file)
--- a/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
+++ b/MdeModulePkg/Core/DxeIplPeim/DxeIpl.h
@@ -241,12 +241,12 @@ Decompress (
   );\r
 \r
 /**\r
-   Clear legacy memory located at the first 4K-page.\r
+  Clear legacy memory located at the first 4K-page.\r
 \r
-   This function traverses the whole HOB list to check if memory from 0 to 4095\r
-   exists and has not been allocated, and then clear it if so.\r
+  This function traverses the whole HOB list to check if memory from 0 to 4095\r
+  exists and has not been allocated, and then clear it if so.\r
 \r
-   @param HoStart         The start of HobList passed to DxeCore.\r
+  @param HobStart         The start of HobList passed to DxeCore.\r
 \r
 **/\r
 VOID\r
@@ -255,10 +255,10 @@ ClearFirst4KPage (
   );\r
 \r
 /**\r
-   Return configure status of NULL pointer detection feature\r
+  Return configure status of NULL pointer detection feature.\r
 \r
-   @return TRUE   NULL pointer detection feature is enabled\r
-   @return FALSE  NULL pointer detection feature is disabled\r
+  @return TRUE   NULL pointer detection feature is enabled\r
+  @return FALSE  NULL pointer detection feature is disabled\r
 **/\r
 BOOLEAN\r
 IsNullDetectionEnabled (\r

diff --git a/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c b/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c
index a10dea25fd7fd2c65dfa7c6f3bf51426922ac1e1..29b6205e884d8a58aa583ba3d89c965ecd731284 100644 (file)
--- a/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c
+++ b/MdeModulePkg/Core/DxeIplPeim/X64/VirtualMemory.c
@@ -32,12 +32,12 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #include "VirtualMemory.h"\r
 \r
 /**\r
-   Clear legacy memory located at the first 4K-page, if available.\r
+  Clear legacy memory located at the first 4K-page, if available.\r
 \r
-   This function traverses the whole HOB list to check if memory from 0 to 4095\r
-   exists and has not been allocated, and then clear it if so.\r
+  This function traverses the whole HOB list to check if memory from 0 to 4095\r
+  exists and has not been allocated, and then clear it if so.\r
 \r
-   @param HoStart                   The start of HobList passed to DxeCore.\r
+  @param HobStart                  The start of HobList passed to DxeCore.\r
 \r
 **/\r
 VOID\r
@@ -86,6 +86,13 @@ ClearFirst4KPage (
   return;\r
 }\r
 \r
+/**\r
+  Return configure status of NULL pointer detection feature.\r
+\r
+  @return TRUE   NULL pointer detection feature is enabled\r
+  @return FALSE  NULL pointer detection feature is disabled\r
+\r
+**/\r
 BOOLEAN\r
 IsNullDetectionEnabled (\r
   VOID\r