Synchronize function comment in

[mirror_edk2.git] / MdePkg / Library / BaseDebugLibNull / DebugLib.c

diff --git a/MdePkg/Library/BaseDebugLibNull/DebugLib.c b/MdePkg/Library/BaseDebugLibNull/DebugLib.c
index 6fdf6f97a5b618587d58305d674cd4918523826e..77193466829a0c00f4e555e09c6e8d7374d89ea0 100644 (file)
--- a/MdePkg/Library/BaseDebugLibNull/DebugLib.c
+++ b/MdePkg/Library/BaseDebugLibNull/DebugLib.c
@@ -12,7 +12,6 @@
 \r
 **/\r
 \r
-\r
 #include <Base.h>\r
 #include <Library/DebugLib.h>\r
 \r
@@ -23,6 +22,8 @@
   the message specified by Format and the associated variable argument list to \r
   the debug output device.\r
 \r
+  If Format is NULL, then ASSERT().\r
+\r
   @param  ErrorLevel  The error level of the debug message.\r
   @param  Format      Format string for the debug message to print.\r
   @param  ...         Variable argument list whose contents are accessed \r
@@ -44,17 +45,16 @@ DebugPrint (
   Prints an assert message containing a filename, line number, and description.  \r
   This may be followed by a breakpoint or a dead loop.\r
 \r
-  Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n" \r
+  Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"\r
   to the debug output device.  If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of \r
   PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if \r
   DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then \r
   CpuDeadLoop() is called.  If neither of these bits are set, then this function \r
   returns immediately after the message is printed to the debug output device.\r
-  DebugAssert() must actively prevent recusrsion.  If DebugAssert() is called while\r
+  DebugAssert() must actively prevent recursion.  If DebugAssert() is called while\r
   processing another DebugAssert(), then DebugAssert() must return immediately.\r
 \r
   If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.\r
-\r
   If Description is NULL, then a <Description> string of "(NULL) Description" is printed.\r
 \r
   @param  FileName     Pointer to the name of the source file that generated the assert condition.\r
@@ -80,13 +80,12 @@ DebugAssert (
   PcdDebugClearMemoryValue, and returns Buffer.\r
 \r
   If Buffer is NULL, then ASSERT().\r
+  If Length is greater than (MAX_ADDRESS -Buffer + 1), then ASSERT(). \r
 \r
-  If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). \r
-\r
-  @param   Buffer  Pointer to the target buffer to fill with PcdDebugClearMemoryValue.\r
+  @param   Buffer  Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.\r
   @param   Length  Number of bytes in Buffer to fill with zeros PcdDebugClearMemoryValue. \r
 \r
-  @return  Buffer filled with PcdDebugClearMemoryValue.\r
+  @return  Buffer  Pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
 \r
 **/\r
 VOID *\r
@@ -108,8 +107,6 @@ DebugClearMemory (
 \r
   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set.\r
   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear.\r
-  \r
-  @return  Always return FALSE.\r
 \r
 **/\r
 BOOLEAN\r
@@ -122,16 +119,14 @@ DebugAssertEnabled (
 }\r
 \r
 \r
-/**\r
-  Returns TRUE if the DEBUG() macro is enabled.\r
+/**  \r
+  Returns TRUE if DEBUG() macros are enabled.\r
 \r
   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of \r
   PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
 \r
   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is set.\r
   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of PcdDebugProperyMask is clear.\r
-  \r
-  @return Always return FALSE.\r
 \r
 **/\r
 BOOLEAN\r
@@ -144,16 +139,14 @@ DebugPrintEnabled (
 }\r
 \r
 \r
-/**\r
-  Returns TRUE if the DEBUG_CODE() macros are enabled.\r
+/**  \r
+  Returns TRUE if DEBUG_CODE() macros are enabled.\r
 \r
   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of \r
   PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
 \r
   @retval  TRUE    The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is set.\r
   @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of PcdDebugProperyMask is clear.\r
-  \r
-  @return  Always return FALSE.\r
 \r
 **/\r
 BOOLEAN\r
@@ -166,16 +159,14 @@ DebugCodeEnabled (
 }\r
 \r
 \r
-/**\r
-  Returns TRUE if the DEBUG_CLEAR_MEMORY() macro is enabled.\r
+/**  \r
+  Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.\r
 \r
   This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of \r
   PcdDebugProperyMask is set.  Otherwise FALSE is returned.\r
 \r
   @retval  TRUE    The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
   @retval  FALSE   The DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\r
-  \r
-  @return  Always return FALSE.\r
 \r
 **/\r
 BOOLEAN\r