Refine the comments in PciSegmentLib

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

diff --git a/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c b/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
index 217f164de5d6d386a5ef9b7cb3441ff4687fb4aa..6d5ae16e73d9d9d559d884bf33517d437114e07c 100644 (file)
--- a/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
+++ b/MdePkg/Library/UefiDebugLibStdErr/DebugLib.c
@@ -15,7 +15,6 @@
 \r
 #include <Uefi.h>\r
 \r
-\r
 #include <Library/DebugLib.h>\r
 #include <Library/UefiBootServicesTableLib.h>\r
 #include <Library/PrintLib.h>\r
@@ -30,7 +29,6 @@
 \r
 \r
 /**\r
-\r
   Prints a debug message to the debug output device if the specified error level is enabled.\r
 \r
   If any bit in ErrorLevel is also set in PcdDebugPrintErrorLevel, then print \r
@@ -41,7 +39,8 @@
 \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
+  @param  ...         Variable argument list whose contents are accessed \r
+                      based on the format string specified by Format.\r
 \r
 **/\r
 VOID\r
@@ -53,7 +52,6 @@ DebugPrint (
   )\r
 {\r
   CHAR16   Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
-  CHAR8    AsciiBuffer[MAX_DEBUG_MESSAGE_LENGTH];\r
   VA_LIST  Marker;\r
 \r
   //\r
@@ -72,8 +70,7 @@ DebugPrint (
   // Convert the DEBUG() message to a Unicode String\r
   //\r
   VA_START (Marker, Format);\r
-  AsciiVSPrint (AsciiBuffer, sizeof (AsciiBuffer), Format, Marker);\r
-  AsciiStrToUnicodeStr (AsciiBuffer, Buffer);\r
+  UnicodeVSPrintAsciiFormat (Buffer, MAX_DEBUG_MESSAGE_LENGTH, Format, Marker);\r
   VA_END (Marker);\r
 \r
   //\r
@@ -86,21 +83,19 @@ DebugPrint (
 \r
 \r
 /**\r
-\r
   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
@@ -117,14 +112,19 @@ DebugAssert (
   )\r
 {\r
   CHAR16  Buffer[MAX_DEBUG_MESSAGE_LENGTH];\r
-  CHAR8   AsciiBuffer[MAX_DEBUG_MESSAGE_LENGTH];\r
 \r
   //\r
   // Generate the ASSERT() message in Unicode format\r
   //\r
-  AsciiSPrint (AsciiBuffer, sizeof (AsciiBuffer), "ASSERT %a(%d): %a\n", FileName, LineNumber, Description);\r
-  AsciiStrToUnicodeStr (AsciiBuffer, Buffer);\r
-\r
+  UnicodeSPrintAsciiFormat (\r
+    Buffer, \r
+    MAX_DEBUG_MESSAGE_LENGTH,\r
+    "ASSERT %a(%d): %a\n", \r
+    FileName, \r
+    LineNumber, \r
+    Description\r
+    );\r
+    \r
   //\r
   // Send the print string to the Standard Error device\r
   //\r
@@ -144,17 +144,15 @@ DebugAssert (
 \r
 \r
 /**\r
-\r
   Fills a target buffer with PcdDebugClearMemoryValue, and returns the target buffer.\r
 \r
   This function fills Length bytes of Buffer with the value specified by \r
   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  Pointer to the target buffer filled with PcdDebugClearMemoryValue.\r
@@ -180,7 +178,6 @@ DebugClearMemory (
 \r
 \r
 /**\r
-  \r
   Returns TRUE if ASSERT() macros are enabled.\r
 \r
   This function returns TRUE if the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of \r
@@ -200,9 +197,8 @@ DebugAssertEnabled (
 }\r
 \r
 \r
-/**\r
-  \r
-  Returns TRUE if DEBUG()macros are 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
@@ -221,9 +217,8 @@ DebugPrintEnabled (
 }\r
 \r
 \r
-/**\r
-  \r
-  Returns TRUE if 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
@@ -242,9 +237,8 @@ DebugCodeEnabled (
 }\r
 \r
 \r
-/**\r
-  \r
-  Returns TRUE if 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