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>
This commit is contained in:
Dandan Bi 2017-10-19 15:42:27 +08:00 committed by Eric Dong
parent 71d047b483
commit 382aeac2c8
2 changed files with 18 additions and 11 deletions

View File

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

View File

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