X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=MdePkg%2FLibrary%2FBasePrintLib%2FPrintLibInternal.h;h=0f7bebff454fdc9b0823d239302c6e15be048f91;hp=c7fecfd34c5644b980057cd6b680e85cb97cf816;hb=3f9f540dacca2249904d204836496334826de58f;hpb=86d9a2e25ed70533e24fc7ad274ccdf6498db864

diff --git a/MdePkg/Library/BasePrintLib/PrintLibInternal.h b/MdePkg/Library/BasePrintLib/PrintLibInternal.h
index c7fecfd34c..0f7bebff45 100644
--- a/MdePkg/Library/BasePrintLib/PrintLibInternal.h
+++ b/MdePkg/Library/BasePrintLib/PrintLibInternal.h
@@ -14,8 +14,6 @@
 
 **/
 
-
-
 //
 // Print primitives
 //
@@ -44,7 +42,7 @@
 #define MAXIMUM_VALUE_CHARACTERS  38
 
 //
-//
+// Record date and time information
 //
 typedef struct {
   UINT16  Year;
@@ -60,6 +58,25 @@ typedef struct {
   UINT8   Pad2;
 } TIME;
 
+/**
+  Worker function that produces a Null-terminated string in an output buffer 
+  based on a Null-terminated format string and variable argument list.
+
+  VSPrint function to process format and place the results in Buffer. Since a 
+  VA_LIST is used this rountine allows the nesting of Vararg routines. Thus 
+  this is the main print working routine
+
+  @param  Buffer        Character buffer to print the results of the parsing
+                        of Format into.
+  @param  BufferSize    Maximum number of characters to put into buffer.
+                        Zero means no limit.
+  @param  Flags         Intial flags value.
+                        Can only have FORMAT_UNICODE and OUTPUT_UNICODE set
+  @param  FormatString  Null-terminated format string.
+
+  @return Number of characters printed.
+
+**/
 UINTN
 BasePrintLibSPrint (
   OUT CHAR8        *Buffer,
@@ -69,6 +86,19 @@ BasePrintLibSPrint (
   ...
   );
 
+/**
+  Internal function that places the character into the Buffer.
+
+  Internal function that places ASCII or Unicode character into the Buffer.
+
+  @param  Buffer      Buffer to place the Unicode or ASCII string.
+  @param  Length      Count of character to be placed into Buffer.
+  @param  Character   Character to be placed into Buffer.
+  @param  Increment   Character increment in Buffer.
+
+  @return Number of characters printed.
+
+**/
 CHAR8 *
 BasePrintLibFillBuffer (
   CHAR8   *Buffer,
@@ -77,6 +107,18 @@ BasePrintLibFillBuffer (
   INTN    Increment
   );
 
+/**
+  Internal function that convert a decimal number to a string in Buffer.
+
+  Print worker function that convert a decimal number to a string in Buffer.
+
+  @param  Buffer    Location to place the Unicode or ASCII string of Value.
+  @param  Value     Value to convert to a Decimal or Hexidecimal string in Buffer.
+  @param  Radix     Radix of the value
+
+  @return Number of characters printed.
+
+**/
 UINTN
 EFIAPI
 BasePrintLibValueToString (
@@ -85,6 +127,43 @@ BasePrintLibValueToString (
   IN UINTN      Radix
   );
 
+/**
+  Internal function that converts a decimal value to a Null-terminated string.
+  
+  Converts the decimal number specified by Value to a Null-terminated  
+  string specified by Buffer containing at most Width characters.
+  If Width is 0 then a width of  MAXIMUM_VALUE_CHARACTERS is assumed.
+  The total number of characters placed in Buffer is returned.
+  If the conversion contains more than Width characters, then only the first
+  Width characters are returned, and the total number of characters 
+  required to perform the conversion is returned.
+  Additional conversion parameters are specified in Flags.  
+  The Flags bit LEFT_JUSTIFY is always ignored.
+  All conversions are left justified in Buffer.
+  If Width is 0, PREFIX_ZERO is ignored in Flags.
+  If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas
+  are inserted every 3rd digit starting from the right.
+  If Value is < 0, then the fist character in Buffer is a '-'.
+  If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, 
+  then Buffer is padded with '0' characters so the combination of the optional '-' 
+  sign character, '0' characters, digit characters for Value, and the Null-terminator
+  add up to Width characters.
+
+  If Buffer is NULL, then ASSERT().
+  If unsupported bits are set in Flags, then ASSERT().
+  If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()
+
+  @param  Buffer    Pointer to the output buffer for the produced Null-terminated
+                    string.
+  @param  Flags     The bitmask of flags that specify left justification, zero pad,
+                    and commas.
+  @param  Value     The 64-bit signed value to convert to a string.
+  @param  Width	    The maximum number of characters to place in Buffer.
+  @param  Increment Character increment in Buffer.
+  
+  @return Total number of characters required to perform the conversion.
+
+**/
 UINTN
 BasePrintLibConvertValueToString (
   IN OUT CHAR8   *Buffer,