Update the copyright notice format

[mirror_edk2.git] / MdePkg / Library / BasePrintLib / PrintLibInternal.h

diff --git a/MdePkg/Library/BasePrintLib/PrintLibInternal.h b/MdePkg/Library/BasePrintLib/PrintLibInternal.h
index 151ea618983a9c76ba546e8ca2a61e515a43eebe..4c1658a1ce7ba8e4041e1ec570970dbb5d2a11c7 100644 (file)
--- a/MdePkg/Library/BasePrintLib/PrintLibInternal.h
+++ b/MdePkg/Library/BasePrintLib/PrintLibInternal.h
@@ -1,8 +1,8 @@
 /** @file\r
   Base Print Library instance Internal Functions definition.\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
   http://opensource.org/licenses/bsd-license.php\r
@@ -19,7 +19,6 @@
 #include <Library/PrintLib.h>\r
 #include <Library/BaseLib.h>\r
 #include <Library/DebugLib.h>\r
-#include <Library/BaseMemoryLib.h>\r
 \r
 \r
 //\r
@@ -57,27 +56,29 @@ typedef struct {
   based on a Null-terminated format string and a VA_LIST argument list.\r
 \r
   VSPrint function to process format and place the results in Buffer. Since a \r
-  VA_LIST is used this rountine allows the nesting of Vararg routines. Thus \r
+  VA_LIST is used this routine allows the nesting of Vararg routines. Thus \r
   this is the main print working routine.\r
 \r
-  @param  Buffer      Character buffer to print the results of the parsing\r
-                      of Format into.\r
-  @param  BufferSize  Maximum number of characters to put into buffer.\r
-  @param  Flags       Intial flags value.\r
-                      Can only have FORMAT_UNICODE and OUTPUT_UNICODE set.\r
-  @param  Format      Null-terminated format string.\r
-  @param  Marker      Vararg list consumed by processing Format.\r
+  @param  Buffer          Character buffer to print the results of the parsing\r
+                          of Format into.\r
+  @param  BufferSize      Maximum number of characters to put into buffer.\r
+  @param  Flags           Initial flags value.\r
+                          Can only have FORMAT_UNICODE and OUTPUT_UNICODE set.\r
+  @param  Format          Null-terminated format string.\r
+  @param  VaListMarker    VA_LIST style variable argument list consumed by processing Format.\r
+  @param  BaseListMarker  BASE_LIST style variable argument list consumed by processing Format.\r
 \r
   @return Number of characters printed not including the Null-terminator.\r
 \r
 **/\r
 UINTN\r
-BasePrintLibVSPrint (\r
+BasePrintLibSPrintMarker (\r
   OUT CHAR8        *Buffer,\r
   IN  UINTN        BufferSize,\r
   IN  UINTN        Flags,\r
   IN  CONST CHAR8  *Format,\r
-  IN  VA_LIST      Marker\r
+  IN  VA_LIST      VaListMarker,   OPTIONAL\r
+  IN  BASE_LIST    BaseListMarker  OPTIONAL\r
   );\r
 \r
 /**\r
@@ -85,14 +86,14 @@ BasePrintLibVSPrint (
   based on a Null-terminated format string and variable argument list.\r
 \r
   VSPrint function to process format and place the results in Buffer. Since a \r
-  VA_LIST is used this rountine allows the nesting of Vararg routines. Thus \r
+  VA_LIST is used this routine allows the nesting of Vararg routines. Thus \r
   this is the main print working routine\r
 \r
   @param  StartOfBuffer Character buffer to print the results of the parsing\r
                         of Format into.\r
   @param  BufferSize    Maximum number of characters to put into buffer.\r
                         Zero means no limit.\r
-  @param  Flags         Intial flags value.\r
+  @param  Flags         Initial flags value.\r
                         Can only have FORMAT_UNICODE and OUTPUT_UNICODE set\r
   @param  FormatString  Null-terminated format string.\r
   @param  ...           The variable argument list.\r
@@ -118,6 +119,7 @@ BasePrintLibSPrint (
   @param  EndBuffer   The end of the input Buffer. No characters will be\r
                       placed after that. \r
   @param  Length      Count of character to be placed into Buffer.\r
+                      (Negative value indicates no buffer fill.)\r
   @param  Character   Character to be placed into Buffer.\r
   @param  Increment   Character increment in Buffer.\r
 \r
@@ -134,18 +136,18 @@ BasePrintLibFillBuffer (
   );\r
 \r
 /**\r
-  Internal function that convert a decimal number to a string in Buffer.\r
+  Internal function that convert a number to a string in Buffer.\r
 \r
-  Print worker function that convert a decimal number to a string in Buffer.\r
+  Print worker function that converts a decimal or hexadecimal number to an ASCII string in Buffer.\r
 \r
-  @param  Buffer    Location to place the Unicode or ASCII string of Value.\r
+  @param  Buffer    Location to place the ASCII string of Value.\r
   @param  Value     Value to convert to a Decimal or Hexadecimal string in Buffer.\r
   @param  Radix     Radix of the value\r
 \r
-  @return Number of characters printed.\r
+  @return A pointer to the end of buffer filled with ASCII string.\r
 \r
 **/\r
-UINTN\r
+CHAR8 *\r
 BasePrintLibValueToString (\r
   IN OUT CHAR8  *Buffer, \r
   IN INT64      Value, \r