Committing changes to the comments, to improve code documentation.

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / Print2.h

diff --git a/MdeModulePkg/Include/Protocol/Print2.h b/MdeModulePkg/Include/Protocol/Print2.h
index 30c01dc4996e3e7967d51bb10d2dc999079c021f..de590e89aa36f30a682a2199f4544bb6f0348033 100644 (file)
--- a/MdeModulePkg/Include/Protocol/Print2.h
+++ b/MdeModulePkg/Include/Protocol/Print2.h
@@ -18,7 +18,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __PPRINT2_H__\r
 \r
 #define EFI_PRINT2_PROTOCOL_GUID  \\r
-   { 0x5bcc3dbc, 0x8c57, 0x450a, { 0xbb, 0xc, 0xa1, 0xc0, 0xbd, 0xde, 0x48, 0xc } }\r
+  { 0xf05976ef, 0x83f1, 0x4f3d, { 0x86, 0x19, 0xf7, 0x59, 0x5d, 0x41, 0xe5, 0x38 } }\r
 \r
 //\r
 // Forward reference for pure ANSI compatability\r
@@ -26,15 +26,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 typedef struct _EFI_PRINT2_PROTOCOL  EFI_PRINT2_PROTOCOL;\r
 \r
 /**\r
-  Produces a Null-terminated Unicode string in an output buffer based on \r
-  a Null-terminated Unicode format string and a VA_LIST argument list\r
+  Produces a Null-terminated Unicode string in an output buffer, based on \r
+  a Null-terminated Unicode format string and a BASE_LIST argument list\r
   \r
   Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
   and BufferSize.  \r
   The Unicode string is produced by parsing the format string specified by FormatString.  \r
-  Arguments are pulled from the variable argument list specified by Marker based on the \r
+  Arguments are pulled from the variable argument list specified by Marker. Marker is constructed based on the \r
   contents of the format string.  \r
-  The number of Unicode characters in the produced output buffer is returned not including\r
+  This function returns the number of Unicode characters in the produced output buffer, not including\r
   the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
@@ -53,19 +53,19 @@ typedef struct _EFI_PRINT2_PROTOCOL  EFI_PRINT2_PROTOCOL;
                           Unicode string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
   @param  FormatString    Null-terminated Unicode format string.\r
-  @param  Marker          VA_LIST marker for the variable argument list.\r
+  @param  Marker          BASE_LIST marker for the variable argument list.\r
   \r
-  @return The number of Unicode characters in the produced output buffer not including the\r
+  @return The number of Unicode characters in the produced output buffer, not including the\r
           Null-terminator.\r
 \r
 **/\r
 typedef\r
 UINTN\r
-(EFIAPI *UNICODE_VS_PRINT) (\r
+(EFIAPI *UNICODE_BS_PRINT) (\r
   OUT CHAR16        *StartOfBuffer,\r
   IN  UINTN         BufferSize,\r
   IN  CONST CHAR16  *FormatString,\r
-  IN  VA_LIST       Marker\r
+  IN  BASE_LIST     Marker\r
   );\r
 \r
 /**\r
@@ -76,7 +76,7 @@ UINTN
   and BufferSize.\r
   The Unicode string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list based on the contents of the format string.\r
-  The number of Unicode characters in the produced output buffer is returned not including\r
+  This function returns the number of Unicode characters in the produced output buffer, not including\r
   the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
@@ -112,15 +112,15 @@ UINTN
   );\r
 \r
 /**\r
-  Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated\r
-  ASCII format string and a VA_LIST argument list\r
+  Produces a Null-terminated Unicode string in an output buffer, based on a Null-terminated\r
+  ASCII format string and a BASE_LIST argument list\r
   \r
   Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
   and BufferSize.\r
   The Unicode string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list specified by Marker based on the \r
   contents of the format string.\r
-  The number of Unicode characters in the produced output buffer is returned not including\r
+  This function returns the number of Unicode characters in the produced output buffer, not including\r
   the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
@@ -138,7 +138,7 @@ UINTN
                           Unicode string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
   @param  FormatString    Null-terminated ASCII format string.\r
-  @param  Marker          VA_LIST marker for the variable argument list.\r
+  @param  Marker          BASE_LIST marker for the variable argument list.\r
   \r
   @return The number of Unicode characters in the produced output buffer not including the\r
           Null-terminator.\r
@@ -146,23 +146,23 @@ UINTN
 **/\r
 typedef\r
 UINTN\r
-(EFIAPI *UNICODE_VS_PRINT_ASCII_FORMAT) (\r
+(EFIAPI *UNICODE_BS_PRINT_ASCII_FORMAT) (\r
   OUT CHAR16       *StartOfBuffer,\r
   IN  UINTN        BufferSize,\r
   IN  CONST CHAR8  *FormatString,\r
-  IN  VA_LIST      Marker\r
+  IN  BASE_LIST    Marker\r
   );\r
 \r
 /**\r
   Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated \r
-  ASCII format string and  variable argument list.\r
+  ASCII format string and a variable argument list.\r
   \r
   Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
   and BufferSize.\r
   The Unicode string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list based on the contents of the \r
   format string.\r
-  The number of Unicode characters in the produced output buffer is returned not including\r
+  This function returns the number of Unicode characters in the produced output buffer, not including\r
   the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
@@ -201,11 +201,11 @@ UINTN
   \r
   Converts the decimal number specified by Value to a Null-terminated Unicode \r
   string specified by Buffer containing at most Width characters. No padding of spaces \r
-  is ever performed. If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
-  The number of Unicode characters in Buffer is returned not including the Null-terminator.\r
-  If the conversion contains more than Width characters, then only the first\r
-  Width characters are returned, and the total number of characters \r
-  required to perform the conversion is returned.\r
+  is ever performed. If Width is 0, then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
+  This function returns the number of Unicode characters in Buffer, not including\r
+  the Null-terminator.\r
+  If the conversion contains more than Width characters, this function returns \r
+  the first Width characters in the conversion, along with the total number of characters in the conversion.\r
   Additional conversion parameters are specified in Flags.  \r
   \r
   The Flags bit LEFT_JUSTIFY is always ignored.\r
@@ -248,14 +248,14 @@ UINTN
 \r
 /**\r
   Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
-  ASCII format string and a VA_LIST argument list.\r
+  ASCII format string and a BASE_LIST argument list.\r
   \r
   Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
   and BufferSize.\r
   The ASCII string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list specified by Marker based on \r
   the contents of the format string.\r
-  The number of ASCII characters in the produced output buffer is returned not including\r
+  This function returns the number of ASCII characters in the output buffer, not including\r
   the Null-terminator.\r
   If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
@@ -272,7 +272,7 @@ UINTN
                           ASCII string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
   @param  FormatString    Null-terminated ASCII format string.\r
-  @param  Marker          VA_LIST marker for the variable argument list.\r
+  @param  Marker          BASE_LIST marker for the variable argument list.\r
   \r
   @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r
@@ -280,23 +280,23 @@ UINTN
 **/\r
 typedef\r
 UINTN\r
-(EFIAPI *ASCII_VS_PRINT) (\r
+(EFIAPI *ASCII_BS_PRINT) (\r
   OUT CHAR8         *StartOfBuffer,\r
   IN  UINTN         BufferSize,\r
   IN  CONST CHAR8   *FormatString,\r
-  IN  VA_LIST       Marker\r
+  IN  BASE_LIST     Marker\r
   );\r
 \r
 /**\r
   Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
-  ASCII format string and  variable argument list.\r
+  ASCII format string and variable argument list.\r
   \r
   Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
   and BufferSize.\r
   The ASCII string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list based on the contents of the \r
   format string.\r
-  The number of ASCII characters in the produced output buffer is returned not including\r
+  This function returns the number of ASCII characters in the output buffer, not including\r
   the Null-terminator.\r
   If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
@@ -331,14 +331,14 @@ UINTN
 \r
 /**\r
   Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
-  Unicode format string and a VA_LIST argument list.\r
+  Unicode format string and a BASE_LIST argument list.\r
   \r
   Produces a Null-terminated ASCII string in the output buffer specified by StartOfBuffer\r
   and BufferSize.\r
   The ASCII string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list specified by Marker based on \r
   the contents of the format string.\r
-  The number of ASCII characters in the produced output buffer is returned not including\r
+  This function returns the number of ASCII characters in the output buffer, not including\r
   the Null-terminator.\r
   If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
@@ -356,7 +356,7 @@ UINTN
                           ASCII string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
   @param  FormatString    Null-terminated Unicode format string.\r
-  @param  Marker          VA_LIST marker for the variable argument list.\r
+  @param  Marker          BASE_LIST marker for the variable argument list.\r
   \r
   @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r
@@ -364,11 +364,11 @@ UINTN
 **/\r
 typedef\r
 UINTN\r
-(EFIAPI *ASCII_VS_PRINT_UNICODE_FORMAT) (\r
+(EFIAPI *ASCII_BS_PRINT_UNICODE_FORMAT) (\r
   OUT CHAR8         *StartOfBuffer,\r
   IN  UINTN         BufferSize,\r
   IN  CONST CHAR16  *FormatString,\r
-  IN  VA_LIST       Marker\r
+  IN  BASE_LIST     Marker\r
   );\r
 \r
 /**\r
@@ -380,7 +380,7 @@ UINTN
   The ASCII string is produced by parsing the format string specified by FormatString.\r
   Arguments are pulled from the variable argument list based on the contents of the \r
   format string.\r
-  The number of ASCII characters in the produced output buffer is returned not including\r
+  This function returns the number of ASCII characters in the output buffer, not including\r
   the Null-terminator.\r
   If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
@@ -420,7 +420,7 @@ UINTN
   Converts the decimal number specified by Value to a Null-terminated ASCII string \r
   specified by Buffer containing at most Width characters. No padding of spaces \r
   is ever performed.\r
-  If Width is 0 then a width of  MAXIMUM_VALUE_CHARACTERS is assumed.\r
+  If Width is 0 then a width of MAXIMUM_VALUE_CHARACTERS is assumed.\r
   The number of ASCII characters in Buffer is returned not including the Null-terminator.\r
   If the conversion contains more than Width characters, then only the first Width\r
   characters are returned, and the total number of characters required to perform\r
@@ -464,16 +464,16 @@ UINTN
   );\r
 \r
 struct _EFI_PRINT2_PROTOCOL {\r
-  UNICODE_VS_PRINT                 UnicodeVSPrint;\r
-  UNICODE_S_PRINT                  UnicodeSPrint;\r
-  UNICODE_VS_PRINT_ASCII_FORMAT    UnicodeVSPrintAsciiFormat;\r
-  UNICODE_S_PRINT_ASCII_FORMAT     UnicodeSPrintAsciiFormat;\r
-  UNICODE_VALUE_TO_STRING          UnicodeValueToString;\r
-  ASCII_VS_PRINT                   AsciiVSPrint;\r
-  ASCII_S_PRINT                    AsciiSPrint;\r
-  ASCII_VS_PRINT_UNICODE_FORMAT    AsciiVSPrintUnicodeFormat;\r
-  ASCII_S_PRINT_UNICODE_FORMAT     AsciiSPrintUnicodeFormat;\r
-  ASCII_VALUE_TO_STRING            AsciiValueToString;\r
+  UNICODE_BS_PRINT                     UnicodeBSPrint;\r
+  UNICODE_S_PRINT                      UnicodeSPrint;\r
+  UNICODE_BS_PRINT_ASCII_FORMAT        UnicodeBSPrintAsciiFormat;\r
+  UNICODE_S_PRINT_ASCII_FORMAT         UnicodeSPrintAsciiFormat;\r
+  UNICODE_VALUE_TO_STRING              UnicodeValueToString;\r
+  ASCII_BS_PRINT                       AsciiBSPrint;\r
+  ASCII_S_PRINT                        AsciiSPrint;\r
+  ASCII_BS_PRINT_UNICODE_FORMAT        AsciiBSPrintUnicodeFormat;\r
+  ASCII_S_PRINT_UNICODE_FORMAT         AsciiSPrintUnicodeFormat;\r
+  ASCII_VALUE_TO_STRING                AsciiValueToString;\r
 };\r
 \r
 extern EFI_GUID gEfiPrint2ProtocolGuid;\r