]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/BasePrintLib/PrintLibInternal.h
Minor grammatical work--mostly adding periods. Items with ONLY period added did...
[mirror_edk2.git] / MdePkg / Library / BasePrintLib / PrintLibInternal.h
index 52ac6d8d5f8cb04ac58542382fdeb1f425aaf9ae..a68a57f0523ce66437b63c2930b1a2f154197865 100644 (file)
@@ -5,7 +5,7 @@
   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
+  http://opensource.org/licenses/bsd-license.php.\r
 \r
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
@@ -59,16 +59,16 @@ typedef struct {
   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
+  @param  Buffer          The 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  BufferSize      The 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  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
+  @return The number of characters printed not including the Null-terminator.\r
 \r
 **/\r
 UINTN\r
@@ -89,16 +89,16 @@ BasePrintLibSPrintMarker (
   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
+  @param  StartOfBuffer The 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  BufferSize    The maximum number of characters to put into buffer.\r
                         Zero means no limit.\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
 \r
-  @return Number of characters printed.\r
+  @return The number of characters printed.\r
 \r
 **/\r
 UINTN\r
@@ -119,10 +119,10 @@ BasePrintLibSPrint (
   @param  Buffer      Buffer to place the Unicode or ASCII string.\r
   @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
+  @param  Length      The 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
+  @param  Character   The character to be placed into Buffer.\r
+  @param  Increment   The character increment in Buffer.\r
 \r
   @return Buffer      Buffer filled with the input Character.\r
 \r
@@ -142,7 +142,7 @@ BasePrintLibFillBuffer (
   Print worker function that converts a decimal or hexadecimal number to an ASCII string in Buffer.\r
 \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  Value     The value to convert to a Decimal or Hexadecimal string in Buffer.\r
   @param  Radix     Radix of the value\r
 \r
   @return A pointer to the end of buffer filled with ASCII string.\r
@@ -181,7 +181,7 @@ BasePrintLibValueToString (
   If unsupported bits are set in Flags, then ASSERT().\r
   If Width >= MAXIMUM_VALUE_CHARACTERS, then ASSERT()\r
 \r
-  @param  Buffer    Pointer to the output buffer for the produced Null-terminated\r
+  @param  Buffer    The pointer to the output buffer for the produced Null-terminated\r
                     string.\r
   @param  Flags     The bitmask of flags that specify left justification, zero pad,\r
                     and commas.\r