X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FLibrary%2FUefiDebugLibConOut%2FDebugLib.c;h=80931256ed307f991c8d405c38d38ecf153a1dba;hp=16a8faa684233b3bb35ee676363f37d687f7ff68;hb=19388d2960b2fe0347da23799e93ccc52f540214;hpb=7c6d32a5648dce51ee0339221b026ea3f6c10b4d

diff --git a/MdePkg/Library/UefiDebugLibConOut/DebugLib.c b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c
index 16a8faa684..80931256ed 100644
--- a/MdePkg/Library/UefiDebugLibConOut/DebugLib.c
+++ b/MdePkg/Library/UefiDebugLibConOut/DebugLib.c
@@ -1,8 +1,8 @@
 /** @file
   UEFI Debug Library that sends messages to the Console Output Device in the EFI System Table.
 
-  Copyright (c) 2006 - 2008, Intel Corporation<BR>
-  All rights reserved. This program and the accompanying materials                          
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>
+  This program and the accompanying materials                          
   are licensed and made available under the terms and conditions of the BSD License         
   which accompanies this distribution.  The full text of the license may be found at        
   http://opensource.org/licenses/bsd-license.php                                            
@@ -12,10 +12,8 @@
 
 **/
 
-
 #include <Uefi.h>
 
-
 #include <Library/DebugLib.h>
 #include <Library/UefiBootServicesTableLib.h>
 #include <Library/PrintLib.h>
@@ -23,15 +21,12 @@
 #include <Library/BaseLib.h>
 #include <Library/BaseMemoryLib.h>
 
-
 //
 // Define the maximum debug and assert message length that this library supports 
 //
 #define MAX_DEBUG_MESSAGE_LENGTH  0x100
 
-
 /**
-
   Prints a debug message to the debug output device if the specified error level is enabled.
 
   If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print 
@@ -42,7 +37,8 @@
 
   @param  ErrorLevel  The error level of the debug message.
   @param  Format      Format string for the debug message to print.
-  @param  ...         The variable argument list.
+  @param  ...         Variable argument list whose contents are accessed 
+                      based on the format string specified by Format.
 
 **/
 VOID
@@ -86,21 +82,19 @@ DebugPrint (
 
 
 /**
-
   Prints an assert message containing a filename, line number, and description.  
   This may be followed by a breakpoint or a dead loop.
 
-  Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n" 
+  Print a message of the form "ASSERT <FileName>(<LineNumber>): <Description>\n"
   to the debug output device.  If DEBUG_PROPERTY_ASSERT_BREAKPOINT_ENABLED bit of 
   PcdDebugProperyMask is set then CpuBreakpoint() is called. Otherwise, if 
   DEBUG_PROPERTY_ASSERT_DEADLOOP_ENABLED bit of PcdDebugProperyMask is set then 
   CpuDeadLoop() is called.  If neither of these bits are set, then this function 
   returns immediately after the message is printed to the debug output device.
-  DebugAssert() must actively prevent recusrsion.  If DebugAssert() is called while
+  DebugAssert() must actively prevent recursion.  If DebugAssert() is called while
   processing another DebugAssert(), then DebugAssert() must return immediately.
 
   If FileName is NULL, then a <FileName> string of "(NULL) Filename" is printed.
-
   If Description is NULL, then a <Description> string of "(NULL) Description" is printed.
 
   @param  FileName     Pointer to the name of the source file that generated the assert condition.
@@ -149,14 +143,12 @@ DebugAssert (
 
 
 /**
-
   Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.
 
   This function fills Length bytes of Buffer with the value specified by 
   PcdDebugClearMemoryValue, and returns Buffer.
 
   If Buffer is NULL, then ASSERT().
-
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT(). 
 
   @param   Buffer  Pointer to the target buffer to be filled with PcdDebugClearMemoryValue.
@@ -185,7 +177,6 @@ DebugClearMemory (
 
 
 /**
-  
   Returns TRUE if ASSERT() macros are enabled.
 
   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of 
@@ -205,9 +196,8 @@ DebugAssertEnabled (
 }
 
 
-/**
-  
-  Returns TRUE if DEBUG()macros are enabled.
+/**  
+  Returns TRUE if DEBUG() macros are enabled.
 
   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_PRINT_ENABLED bit of 
   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
@@ -226,9 +216,8 @@ DebugPrintEnabled (
 }
 
 
-/**
-  
-  Returns TRUE if DEBUG_CODE()macros are enabled.
+/**  
+  Returns TRUE if DEBUG_CODE() macros are enabled.
 
   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CODE_ENABLED bit of 
   PcdDebugProperyMask is set.  Otherwise FALSE is returned.
@@ -247,9 +236,8 @@ DebugCodeEnabled (
 }
 
 
-/**
-  
-  Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.
+/**  
+  Returns TRUE if DEBUG_CLEAR_MEMORY() macro is enabled.
 
   This function returns TRUE if the DEBUG_PROPERTY_CLEAR_MEMORY_ENABLED bit of 
   PcdDebugProperyMask is set.  Otherwise FALSE is returned.