summaryrefslogtreecommitdiffstats
path: root/MdePkg/Library/BasePrintLib
diff options
context:
space:
mode:
authormyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>2010-06-25 21:56:02 +0000
committermyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>2010-06-25 21:56:02 +0000
commit2fc59a003ed9104f9feebe0e418f2a04a50f3284 (patch)
tree6db3e57a6dc3e203bcc9cbc509ea734379fc9e29 /MdePkg/Library/BasePrintLib
parent22f6824925d63a113d1323120c6468114581b67a (diff)
downloadedk2-2fc59a003ed9104f9feebe0e418f2a04a50f3284.tar.gz
edk2-2fc59a003ed9104f9feebe0e418f2a04a50f3284.tar.bz2
edk2-2fc59a003ed9104f9feebe0e418f2a04a50f3284.zip
Minor grammatical work--mostly adding periods. Items with ONLY period added did not have the heading date changed, but Items with content changes had heading copyright dates updated. Sending separately a list of files missing Doxygen @param and @return information. (PENDING)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10604 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Library/BasePrintLib')
-rw-r--r--MdePkg/Library/BasePrintLib/BasePrintLib.inf2
-rw-r--r--MdePkg/Library/BasePrintLib/PrintLib.c32
-rw-r--r--MdePkg/Library/BasePrintLib/PrintLibInternal.c36
-rw-r--r--MdePkg/Library/BasePrintLib/PrintLibInternal.h26
4 files changed, 48 insertions, 48 deletions
diff --git a/MdePkg/Library/BasePrintLib/BasePrintLib.inf b/MdePkg/Library/BasePrintLib/BasePrintLib.inf
index 6054c7a78c..9927cebdd7 100644
--- a/MdePkg/Library/BasePrintLib/BasePrintLib.inf
+++ b/MdePkg/Library/BasePrintLib/BasePrintLib.inf
@@ -6,7 +6,7 @@
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
-# http://opensource.org/licenses/bsd-license.php
+# http://opensource.org/licenses/bsd-license.php.
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#
diff --git a/MdePkg/Library/BasePrintLib/PrintLib.c b/MdePkg/Library/BasePrintLib/PrintLib.c
index a5f324d45d..6add9cbbe6 100644
--- a/MdePkg/Library/BasePrintLib/PrintLib.c
+++ b/MdePkg/Library/BasePrintLib/PrintLib.c
@@ -1,12 +1,12 @@
/** @file
Base Print Library instance implementation.
- Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
Portions copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php
+ http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@@ -52,7 +52,7 @@ VA_LIST gNullVaList;
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
- @param FormatString Null-terminated Unicode format string.
+ @param FormatString A Null-terminated Unicode format string.
@param Marker VA_LIST marker for the variable argument list.
@return The number of Unicode characters in the produced output buffer not including the
@@ -100,7 +100,7 @@ UnicodeVSPrint (
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
- @param FormatString Null-terminated Unicode format string.
+ @param FormatString A Null-terminated Unicode format string.
@param Marker BASE_LIST marker for the variable argument list.
@return The number of Unicode characters in the produced output buffer not including the
@@ -147,7 +147,7 @@ UnicodeBSPrint (
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
- @param FormatString Null-terminated Unicode format string.
+ @param FormatString A Null-terminated Unicode format string.
@param ... Variable argument list whose contents are accessed based on the
format string specified by FormatString.
@@ -196,7 +196,7 @@ UnicodeSPrint (
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
- @param FormatString Null-terminated ASCII format string.
+ @param FormatString A Null-terminated ASCII format string.
@param Marker VA_LIST marker for the variable argument list.
@return The number of Unicode characters in the produced output buffer not including the
@@ -242,7 +242,7 @@ UnicodeVSPrintAsciiFormat (
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
- @param FormatString Null-terminated ASCII format string.
+ @param FormatString A Null-terminated ASCII format string.
@param Marker BASE_LIST marker for the variable argument list.
@return The number of Unicode characters in the produced output buffer not including the
@@ -288,7 +288,7 @@ UnicodeBSPrintAsciiFormat (
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
Unicode string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
- @param FormatString Null-terminated ASCII format string.
+ @param FormatString A Null-terminated ASCII format string.
@param ... Variable argument list whose contents are accessed based on the
format string specified by FormatString.
@@ -342,7 +342,7 @@ UnicodeSPrintAsciiFormat (
If both COMMA_TYPE and RADIX_HEX 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
+ @param Buffer The pointer to the output buffer for the produced Null-terminated
Unicode 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.
@@ -390,7 +390,7 @@ UnicodeValueToString (
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
- @param FormatString Null-terminated ASCII format string.
+ @param FormatString A Null-terminated ASCII format string.
@param Marker VA_LIST marker for the variable argument list.
@return The number of ASCII characters in the produced output buffer not including the
@@ -434,7 +434,7 @@ AsciiVSPrint (
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
- @param FormatString Null-terminated ASCII format string.
+ @param FormatString A Null-terminated ASCII format string.
@param Marker BASE_LIST marker for the variable argument list.
@return The number of ASCII characters in the produced output buffer not including the
@@ -478,7 +478,7 @@ AsciiBSPrint (
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
- @param FormatString Null-terminated ASCII format string.
+ @param FormatString A Null-terminated ASCII format string.
@param ... Variable argument list whose contents are accessed based on the
format string specified by FormatString.
@@ -527,7 +527,7 @@ AsciiSPrint (
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
- @param FormatString Null-terminated Unicode format string.
+ @param FormatString A Null-terminated Unicode format string.
@param Marker VA_LIST marker for the variable argument list.
@return The number of ASCII characters in the produced output buffer not including the
@@ -573,7 +573,7 @@ AsciiVSPrintUnicodeFormat (
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
- @param FormatString Null-terminated Unicode format string.
+ @param FormatString A Null-terminated Unicode format string.
@param Marker BASE_LIST marker for the variable argument list.
@return The number of ASCII characters in the produced output buffer not including the
@@ -619,7 +619,7 @@ AsciiBSPrintUnicodeFormat (
@param StartOfBuffer A pointer to the output buffer for the produced Null-terminated
ASCII string.
@param BufferSize The size, in bytes, of the output buffer specified by StartOfBuffer.
- @param FormatString Null-terminated Unicode format string.
+ @param FormatString A Null-terminated Unicode format string.
@param ... Variable argument list whose contents are accessed based on the
format string specified by FormatString.
@@ -673,7 +673,7 @@ AsciiSPrintUnicodeFormat (
If both COMMA_TYPE and RADIX_HEX 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
+ @param Buffer The pointer to the output buffer for the produced Null-terminated
ASCII 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.
diff --git a/MdePkg/Library/BasePrintLib/PrintLibInternal.c b/MdePkg/Library/BasePrintLib/PrintLibInternal.c
index 6ed034615a..085d37f151 100644
--- a/MdePkg/Library/BasePrintLib/PrintLibInternal.c
+++ b/MdePkg/Library/BasePrintLib/PrintLibInternal.c
@@ -1,11 +1,11 @@
/** @file
Print Library internal worker functions.
- Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
+ Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php
+ http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@@ -57,15 +57,15 @@ GLOBAL_REMOVE_IF_UNREFERENCED CONST CHAR8 *mStatusString[] = {
Internal function that places ASCII or Unicode character into the Buffer.
- @param Buffer Buffer to place the Unicode or ASCII string.
+ @param Buffer The buffer to place the Unicode or ASCII string.
@param EndBuffer The end of the input Buffer. No characters will be
placed after that.
- @param Length Count of character to be placed into Buffer.
+ @param Length The count of character to be placed into Buffer.
(Negative value indicates no buffer fill.)
- @param Character Character to be placed into Buffer.
- @param Increment Character increment in Buffer.
+ @param Character The character to be placed into Buffer.
+ @param Increment The character increment in Buffer.
- @return Buffer Buffer filled with the input Character.
+ @return Buffer.
**/
CHAR8 *
@@ -96,7 +96,7 @@ BasePrintLibFillBuffer (
Print worker function that converts a decimal or hexadecimal number to an ASCII string in Buffer.
@param Buffer Location to place the ASCII string of Value.
- @param Value Value to convert to a Decimal or Hexadecimal string in Buffer.
+ @param Value The value to convert to a Decimal or Hexadecimal string in Buffer.
@param Radix Radix of the value
@return A pointer to the end of buffer filled with ASCII string.
@@ -152,14 +152,14 @@ BasePrintLibValueToString (
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
+ @param Buffer The 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, not including
the Null-terminator.
- @param Increment Character increment in Buffer.
+ @param Increment The character increment in Buffer.
@return Total number of characters required to perform the conversion.
@@ -275,16 +275,16 @@ BasePrintLibConvertValueToString (
VA_LIST is used this routine 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
+ @param Buffer The character buffer to print the results of the parsing
of Format into.
- @param BufferSize Maximum number of characters to put into buffer.
+ @param BufferSize The maximum number of characters to put into buffer.
@param Flags Initial flags value.
Can only have FORMAT_UNICODE and OUTPUT_UNICODE set.
- @param Format Null-terminated format string.
+ @param Format A Null-terminated format string.
@param VaListMarker VA_LIST style variable argument list consumed by processing Format.
@param BaseListMarker BASE_LIST style variable argument list consumed by processing Format.
- @return Number of characters printed not including the Null-terminator.
+ @return The number of characters printed not including the Null-terminator.
**/
UINTN
@@ -898,16 +898,16 @@ BasePrintLibSPrintMarker (
VA_LIST is used this routine allows the nesting of Vararg routines. Thus
this is the main print working routine
- @param StartOfBuffer Character buffer to print the results of the parsing
+ @param StartOfBuffer The character buffer to print the results of the parsing
of Format into.
- @param BufferSize Maximum number of characters to put into buffer.
+ @param BufferSize The maximum number of characters to put into buffer.
Zero means no limit.
@param Flags Initial flags value.
Can only have FORMAT_UNICODE and OUTPUT_UNICODE set
- @param FormatString Null-terminated format string.
+ @param FormatString A Null-terminated format string.
@param ... The variable argument list.
- @return Number of characters printed.
+ @return The number of characters printed.
**/
UINTN
diff --git a/MdePkg/Library/BasePrintLib/PrintLibInternal.h b/MdePkg/Library/BasePrintLib/PrintLibInternal.h
index 52ac6d8d5f..a68a57f052 100644
--- a/MdePkg/Library/BasePrintLib/PrintLibInternal.h
+++ b/MdePkg/Library/BasePrintLib/PrintLibInternal.h
@@ -5,7 +5,7 @@
This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php
+ http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
@@ -59,16 +59,16 @@ typedef struct {
VA_LIST is used this routine 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
+ @param Buffer The character buffer to print the results of the parsing
of Format into.
- @param BufferSize Maximum number of characters to put into buffer.
+ @param BufferSize The maximum number of characters to put into buffer.
@param Flags Initial flags value.
Can only have FORMAT_UNICODE and OUTPUT_UNICODE set.
- @param Format Null-terminated format string.
+ @param Format A Null-terminated format string.
@param VaListMarker VA_LIST style variable argument list consumed by processing Format.
@param BaseListMarker BASE_LIST style variable argument list consumed by processing Format.
- @return Number of characters printed not including the Null-terminator.
+ @return The number of characters printed not including the Null-terminator.
**/
UINTN
@@ -89,16 +89,16 @@ BasePrintLibSPrintMarker (
VA_LIST is used this routine allows the nesting of Vararg routines. Thus
this is the main print working routine
- @param StartOfBuffer Character buffer to print the results of the parsing
+ @param StartOfBuffer The character buffer to print the results of the parsing
of Format into.
- @param BufferSize Maximum number of characters to put into buffer.
+ @param BufferSize The maximum number of characters to put into buffer.
Zero means no limit.
@param Flags Initial flags value.
Can only have FORMAT_UNICODE and OUTPUT_UNICODE set
@param FormatString Null-terminated format string.
@param ... The variable argument list.
- @return Number of characters printed.
+ @return The number of characters printed.
**/
UINTN
@@ -119,10 +119,10 @@ BasePrintLibSPrint (
@param Buffer Buffer to place the Unicode or ASCII string.
@param EndBuffer The end of the input Buffer. No characters will be
placed after that.
- @param Length Count of character to be placed into Buffer.
+ @param Length The count of character to be placed into Buffer.
(Negative value indicates no buffer fill.)
- @param Character Character to be placed into Buffer.
- @param Increment Character increment in Buffer.
+ @param Character The character to be placed into Buffer.
+ @param Increment The character increment in Buffer.
@return Buffer Buffer filled with the input Character.
@@ -142,7 +142,7 @@ BasePrintLibFillBuffer (
Print worker function that converts a decimal or hexadecimal number to an ASCII string in Buffer.
@param Buffer Location to place the ASCII string of Value.
- @param Value Value to convert to a Decimal or Hexadecimal string in Buffer.
+ @param Value The value to convert to a Decimal or Hexadecimal string in Buffer.
@param Radix Radix of the value
@return A pointer to the end of buffer filled with ASCII string.
@@ -181,7 +181,7 @@ BasePrintLibValueToString (
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
+ @param Buffer The 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.