Use doxygen comment style for document entity such as struct, enum, variable that...

[mirror_edk2.git] / MdePkg / Include / Library / DebugLib.h

diff --git a/MdePkg/Include/Library/DebugLib.h b/MdePkg/Include/Library/DebugLib.h
index 693fc3cf7a23dbad0d1d085c7c34337c71bad1b5..828cd441cf22b60bce5d242e121cfa71b96c3d08 100644 (file)
--- a/MdePkg/Include/Library/DebugLib.h
+++ b/MdePkg/Include/Library/DebugLib.h
@@ -28,21 +28,40 @@
 //\r
 // Declare bits for PcdDebugPrintErrorLevel and the ErrorLevel parameter of DebugPrint()\r
 //\r
-#define EFI_D_INIT      0x00000001  // Initialization style messages\r
-#define EFI_D_WARN      0x00000002  // Warnings\r
-#define EFI_D_LOAD      0x00000004  // Load events\r
-#define EFI_D_FS        0x00000008  // EFI File system\r
-#define EFI_D_POOL      0x00000010  // Alloc & Free's\r
-#define EFI_D_PAGE      0x00000020  // Alloc & Free's\r
-#define EFI_D_INFO      0x00000040  // Verbose\r
-#define EFI_D_VARIABLE  0x00000100  // Variable\r
-#define EFI_D_BM        0x00000400  // Boot Manager (BDS)\r
-#define EFI_D_BLKIO     0x00001000  // BlkIo Driver\r
-#define EFI_D_NET       0x00004000  // SNI Driver\r
-#define EFI_D_UNDI      0x00010000  // UNDI Driver\r
-#define EFI_D_LOADFILE  0x00020000  // UNDI Driver\r
-#define EFI_D_EVENT     0x00080000  // Event messages\r
-#define EFI_D_ERROR     0x80000000  // Error\r
+#define DEBUG_INIT      0x00000001  // Initialization\r
+#define DEBUG_WARN      0x00000002  // Warnings\r
+#define DEBUG_LOAD      0x00000004  // Load events\r
+#define DEBUG_FS        0x00000008  // EFI File system\r
+#define DEBUG_POOL      0x00000010  // Alloc & Free's\r
+#define DEBUG_PAGE      0x00000020  // Alloc & Free's\r
+#define DEBUG_INFO      0x00000040  // Verbose\r
+#define DEBUG_VARIABLE  0x00000100  // Variable\r
+#define DEBUG_BM        0x00000400  // Boot Manager\r
+#define DEBUG_BLKIO     0x00001000  // BlkIo Driver\r
+#define DEBUG_NET       0x00004000  // SNI Driver\r
+#define DEBUG_UNDI      0x00010000  // UNDI Driver\r
+#define DEBUG_LOADFILE  0x00020000  // UNDI Driver\r
+#define DEBUG_EVENT     0x00080000  // Event messages\r
+#define DEBUG_ERROR     0x80000000  // Error\r
+\r
+//\r
+// Aliases of debug message mask bits\r
+//\r
+#define EFI_D_INIT      DEBUG_INIT\r
+#define EFI_D_WARN      DEBUG_WARN\r
+#define EFI_D_LOAD      DEBUG_LOAD\r
+#define EFI_D_FS        DEBUG_FS\r
+#define EFI_D_POOL      DEBUG_POOL\r
+#define EFI_D_PAGE      DEBUG_PAGE\r
+#define EFI_D_INFO      DEBUG_INFO\r
+#define EFI_D_VARIABLE  DEBUG_VARIABLE\r
+#define EFI_D_BM        DEBUG_BM\r
+#define EFI_D_BLKIO     DEBUG_BLKIO\r
+#define EFI_D_NET       DEBUG_NET\r
+#define EFI_D_UNDI      DEBUG_UNDI\r
+#define EFI_D_LOADFILE  DEBUG_LOADFILE\r
+#define EFI_D_EVENT     DEBUG_EVENT\r
+#define EFI_D_ERROR     DEBUG_ERROR\r
 \r
 /**\r
 \r
@@ -56,6 +75,7 @@
 \r
   @param  ErrorLevel  The error level of the debug message.\r
   @param  Format      Format string for the debug message to print.\r
+  @param  ...         The variable argument list.\r
 \r
 **/\r
 VOID\r
@@ -78,12 +98,12 @@ DebugPrint (
   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
+  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
+  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
   @param  LineNumber   The line number in the source file that generated the assert condition\r
@@ -108,12 +128,12 @@ DebugAssert (
 \r
   If Buffer is NULL, then ASSERT().\r
 \r
-  If Length is greater than (MAX_ADDRESS ?Buffer + 1), then ASSERT(). \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\r
+  @return  Buffer  Pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
 \r
 **/\r
 VOID *\r
@@ -182,11 +202,11 @@ DebugCodeEnabled (
   \r
   Returns TRUE if DEBUG_CLEAR_MEMORY()macro is enabled.\r
 \r
-  This function returns TRUE if the DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of \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_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is set.\r
-  @retval  FALSE   The DEBUG_PROPERTY_DEBUG_CLEAR_MEMORY_ENABLED bit of PcdDebugProperyMask is clear.\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
 **/\r
 BOOLEAN\r
@@ -351,7 +371,7 @@ DebugClearMemoryEnabled (
   are not included in a module.\r
 \r
 **/\r
-#define DEBUG_CODE_END()    __DebugCodeLocal = 0; } } while (FALSE)\r
+#define DEBUG_CODE_END()    __DebugCodeLocal = 0; __DebugCodeLocal++; } } while (FALSE)\r
 \r
 \r
 /**\r