Update some comments for MdeModulePkg Include header files.

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

diff --git a/MdeModulePkg/Include/Protocol/Print2.h b/MdeModulePkg/Include/Protocol/Print2.h
index de590e89aa36f30a682a2199f4544bb6f0348033..848b2b14dfd0ed117d1a4cb4358db78f09165e2c 100644 (file)
--- a/MdeModulePkg/Include/Protocol/Print2.h
+++ b/MdeModulePkg/Include/Protocol/Print2.h
@@ -29,13 +29,13 @@ typedef struct _EFI_PRINT2_PROTOCOL  EFI_PRINT2_PROTOCOL;
   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
+  Produces a Null-terminated Unicode string in the output buffer \r
+  specified by StartOfBuffer 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. Marker is constructed based on the \r
-  contents of the format string.  \r
-  This function returns the number of Unicode characters in the produced output buffer, not including\r
-  the Null-terminator.\r
+  Arguments are pulled from the variable argument list specified by Marker.\r
+  Marker is constructed based on the contents of the format string.  \r
+  This function returns the number of Unicode characters in the produced output buffer, \r
+  not including the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
@@ -43,8 +43,7 @@ typedef struct _EFI_PRINT2_PROTOCOL  EFI_PRINT2_PROTOCOL;
   If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
   If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
-  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
-  ASSERT().\r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
   contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
   Null-terminator, then ASSERT().\r
@@ -72,12 +71,12 @@ UINTN
   Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated \r
   Unicode format string and variable argument list.\r
   \r
-  Produces a Null-terminated Unicode string in the output buffer specified by StartOfBuffer\r
-  and BufferSize.\r
+  Produces a Null-terminated Unicode string in the output buffer \r
+  specified by StartOfBuffer 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
-  This function returns the number of Unicode characters in the produced output buffer, not including\r
-  the Null-terminator.\r
+  This function returns the number of Unicode characters in the produced output buffer, \r
+  not including the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
@@ -85,8 +84,7 @@ UINTN
   If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
   If BufferSize > 1 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
-  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
-  ASSERT().\r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
   contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
   Null-terminator, then ASSERT().\r
@@ -115,21 +113,20 @@ UINTN
   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
+  Produces a Null-terminated Unicode string in the output buffer \r
+  specified by StartOfBuffer 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
-  This function returns the number of Unicode characters in the produced output buffer, not including\r
-  the Null-terminator.\r
+  This function returns the number of Unicode characters in the produced output buffer, \r
+  not including the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
   If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
   If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
-  ASSERT().\r
+  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
   contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
   Null-terminator, then ASSERT().\r
@@ -157,21 +154,19 @@ UINTN
   Produces a Null-terminated Unicode string in an output buffer based on a Null-terminated \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
+  Produces a Null-terminated Unicode string in the output buffer \r
+  specified by StartOfBuffer 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
-  This function returns the number of Unicode characters in the produced output buffer, not including\r
-  the Null-terminator.\r
+  Arguments are pulled from the variable argument list based on the contents of the format string.\r
+  This function returns the number of Unicode characters in the produced output buffer, \r
+  not including the Null-terminator.\r
   If BufferSize is 0 or 1, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 1 and StartOfBuffer is NULL, then ASSERT().\r
   If BufferSize > 1 and StartOfBuffer is not aligned on a 16-bit boundary, then ASSERT().\r
   If BufferSize > 1 and FormatString is NULL, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
-  ASSERT().\r
+  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and produced Null-terminated Unicode string\r
   contains more than PcdMaximumUnicodeStringLength Unicode characters not including the\r
   Null-terminator, then ASSERT().\r
@@ -250,20 +245,19 @@ UINTN
   Produces a Null-terminated ASCII 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 ASCII string in the output buffer specified by StartOfBuffer\r
-  and BufferSize.\r
+  Produces a Null-terminated ASCII string in the output buffer \r
+  pecified by StartOfBuffer 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
-  This function returns the number of ASCII characters in the output buffer, not including\r
-  the Null-terminator.\r
+  This function returns the number of ASCII characters in the output buffer, \r
+  not including the Null-terminator.\r
   If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
   If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
-  ASSERT().\r
+  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
   contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
   Null-terminator, then ASSERT().\r
@@ -291,20 +285,18 @@ UINTN
   Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\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
+  Produces a Null-terminated ASCII string in the output buffer \r
+  specified by StartOfBuffer 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
-  This function returns the number of ASCII characters in the output buffer, not including\r
-  the Null-terminator.\r
+  Arguments are pulled from the variable argument list based on the contents of the format string.\r
+  This function returns the number of ASCII characters in the output buffer, \r
+  not including the Null-terminator.\r
   If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
   If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then\r
-  ASSERT().\r
+  PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
   contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
   Null-terminator, then ASSERT().\r
@@ -333,21 +325,20 @@ UINTN
   Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\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
+  Produces a Null-terminated ASCII string in the output buffer \r
+  specified by StartOfBuffer 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
-  This function returns the number of ASCII characters in the output buffer, not including\r
-  the Null-terminator.\r
+  This function returns the number of ASCII characters in the output buffer, \r
+  not including the Null-terminator.\r
   If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
   If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
   If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
   If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
-  ASSERT().\r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
   contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
   Null-terminator, then ASSERT().\r
@@ -375,21 +366,19 @@ UINTN
   Produces a Null-terminated ASCII string in an output buffer based on a Null-terminated\r
   Unicode 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
+  Produces a Null-terminated ASCII string in the output buffer \r
+  specified by StartOfBuffer 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
-  This function returns the number of ASCII characters in the output buffer, not including\r
-  the Null-terminator.\r
+  Arguments are pulled from the variable argument list based on the contents of the format string.\r
+  This function returns the number of ASCII characters in the output buffer, \r
+  not including the Null-terminator.\r
   If BufferSize is 0, then no output buffer is produced and 0 is returned.\r
 \r
   If BufferSize > 0 and StartOfBuffer is NULL, then ASSERT().\r
   If BufferSize > 0 and FormatString is NULL, then ASSERT().\r
   If BufferSize > 0 and FormatString is not aligned on a 16-bit boundary, then ASSERT().\r
-  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than\r
-  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then\r
-  ASSERT().\r
+  If PcdMaximumUnicodeStringLength is not zero, and FormatString contains more than \r
+  PcdMaximumUnicodeStringLength Unicode characters not including the Null-terminator, then ASSERT().\r
   If PcdMaximumAsciiStringLength is not zero, and produced Null-terminated ASCII string\r
   contains more than PcdMaximumAsciiStringLength ASCII characters not including the\r
   Null-terminator, then ASSERT().\r
@@ -418,8 +407,7 @@ UINTN
   Converts a decimal value to a Null-terminated ASCII string.\r
   \r
   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
+  specified by Buffer containing at most Width characters. No padding of spaces is ever performed.\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