sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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)

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10596 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
myronporter
2010-06-24 00:20:35 +00:00
parent c5eef36d69
commit 127010dd96
55 changed files with 293 additions and 293 deletions
Download Patch File Download Diff File Expand all files Collapse all files

96
MdePkg/Library/BaseLib/String.c
View File

@@ -1,11 +1,11 @@
/** @file
Unicode and ASCII string primatives.
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.
@@ -43,8 +43,8 @@
PcdMaximumUnicodeStringLength Unicode characters, not including the
Null-terminator, then ASSERT().
@param Destination Pointer to a Null-terminated Unicode string.
@param Source Pointer to a Null-terminated Unicode string.
@param Destination A pointer to a Null-terminated Unicode string.
@param Source A pointer to a Null-terminated Unicode string.
@return Destination.
@@ -101,8 +101,8 @@ StrCpy (
PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
then ASSERT().
@param Destination Pointer to a Null-terminated Unicode string.
@param Source Pointer to a Null-terminated Unicode string.
@param Destination A pointer to a Null-terminated Unicode string.
@param Source A pointer to a Null-terminated Unicode string.
@param Length Maximum number of Unicode characters to copy.
@return Destination.
@@ -161,7 +161,7 @@ StrnCpy (
PcdMaximumUnicodeStringLength Unicode characters, not including the
Null-terminator, then ASSERT().
@param String Pointer to a Null-terminated Unicode string.
@param String A pointer to a Null-terminated Unicode string.
@return The length of String.
@@ -202,7 +202,7 @@ StrLen (
PcdMaximumUnicodeStringLength Unicode characters, not including the
Null-terminator, then ASSERT().
@param String Pointer to a Null-terminated Unicode string.
@param String A pointer to a Null-terminated Unicode string.
@return The size of String.
@@ -237,8 +237,8 @@ StrSize (
than PcdMaximumUnicodeStringLength Unicode characters, not including the
Null-terminator, then ASSERT().
@param FirstString Pointer to a Null-terminated Unicode string.
@param SecondString Pointer to a Null-terminated Unicode string.
@param FirstString A pointer to a Null-terminated Unicode string.
@param SecondString A pointer to a Null-terminated Unicode string.
@retval 0 FirstString is identical to SecondString.
@return others FirstString is not identical to SecondString.
@@ -288,8 +288,8 @@ StrCmp (
PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
then ASSERT().
@param FirstString Pointer to a Null-terminated Unicode string.
@param SecondString Pointer to a Null-terminated Unicode string.
@param FirstString A pointer to a Null-terminated Unicode string.
@param SecondString A pointer to a Null-terminated Unicode string.
@param Length Maximum number of Unicode characters to compare.
@retval 0 FirstString is identical to SecondString.
@@ -356,8 +356,8 @@ StrnCmp (
PcdMaximumUnicodeStringLength Unicode characters, not including the
Null-terminator, then ASSERT().
@param Destination Pointer to a Null-terminated Unicode string.
@param Source Pointer to a Null-terminated Unicode string.
@param Destination A pointer to a Null-terminated Unicode string.
@param Source A pointer to a Null-terminated Unicode string.
@return Destination.
@@ -409,8 +409,8 @@ StrCat (
and Source results in a Unicode string with more than PcdMaximumUnicodeStringLength
Unicode characters, not including the Null-terminator, then ASSERT().
@param Destination Pointer to a Null-terminated Unicode string.
@param Source Pointer to a Null-terminated Unicode string.
@param Destination A pointer to a Null-terminated Unicode string.
@param Source A pointer to a Null-terminated Unicode string.
@param Length Maximum number of Unicode characters to concatenate from
Source.
@@ -458,8 +458,8 @@ StrnCat (
or String contains more than PcdMaximumUnicodeStringLength Unicode
characters, not including the Null-terminator, then ASSERT().
@param String Pointer to a Null-terminated Unicode string.
@param SearchString Pointer to a Null-terminated Unicode string to search for.
@param String A pointer to a Null-terminated Unicode string.
@param SearchString A pointer to a Null-terminated Unicode string to search for.
@retval NULL If the SearchString does not appear in String.
@return others If there is a match.
@@ -641,7 +641,7 @@ InternalIsHexaDecimalDigitCharacter (
more than PcdMaximumUnicodeStringLength Unicode characters, not including
the Null-terminator, then ASSERT().
@param String Pointer to a Null-terminated Unicode string.
@param String A pointer to a Null-terminated Unicode string.
@retval Value translated from String.
@@ -723,7 +723,7 @@ StrDecimalToUintn (
more than PcdMaximumUnicodeStringLength Unicode characters, not including
the Null-terminator, then ASSERT().
@param String Pointer to a Null-terminated Unicode string.
@param String A pointer to a Null-terminated Unicode string.
@retval Value translated from String.
@@ -805,7 +805,7 @@ StrDecimalToUint64 (
PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
then ASSERT().
@param String Pointer to a Null-terminated Unicode string.
@param String A pointer to a Null-terminated Unicode string.
@retval Value translated from String.
@@ -898,7 +898,7 @@ StrHexToUintn (
PcdMaximumUnicodeStringLength Unicode characters, not including the Null-terminator,
then ASSERT().
@param String Pointer to a Null-terminated Unicode string.
@param String A pointer to a Null-terminated Unicode string.
@retval Value translated from String.
@@ -1034,8 +1034,8 @@ InternalAsciiIsHexaDecimalDigitCharacter (
than PcdMaximumAsciiStringLength Unicode characters, not including the
Null-terminator, then ASSERT().
@param Source Pointer to a Null-terminated Unicode string.
@param Destination Pointer to a Null-terminated ASCII string.
@param Source A pointer to a Null-terminated Unicode string.
@param Destination A pointer to a Null-terminated ASCII string.
@return Destination.
@@ -1101,8 +1101,8 @@ UnicodeStrToAsciiStr (
PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT().
@param Destination Pointer to a Null-terminated ASCII string.
@param Source Pointer to a Null-terminated ASCII string.
@param Destination A pointer to a Null-terminated ASCII string.
@param Source A pointer to a Null-terminated ASCII string.
@return Destination
@@ -1155,8 +1155,8 @@ AsciiStrCpy (
PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT().
@param Destination Pointer to a Null-terminated ASCII string.
@param Source Pointer to a Null-terminated ASCII string.
@param Destination A pointer to a Null-terminated ASCII string.
@param Source A pointer to a Null-terminated ASCII string.
@param Length Maximum number of ASCII characters to copy.
@return Destination
@@ -1214,7 +1214,7 @@ AsciiStrnCpy (
PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT().
@param String Pointer to a Null-terminated ASCII string.
@param String A pointer to a Null-terminated ASCII string.
@return The length of String.
@@ -1253,7 +1253,7 @@ AsciiStrLen (
PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT().
@param String Pointer to a Null-terminated ASCII string.
@param String A pointer to a Null-terminated ASCII string.
@return The size of String.
@@ -1286,8 +1286,8 @@ AsciiStrSize (
than PcdMaximumAsciiStringLength ASCII characters, not including the
Null-terminator, then ASSERT().
@param FirstString Pointer to a Null-terminated ASCII string.
@param SecondString Pointer to a Null-terminated ASCII string.
@param FirstString A pointer to a Null-terminated ASCII string.
@param SecondString A pointer to a Null-terminated ASCII string.
@retval ==0 FirstString is identical to SecondString.
@retval !=0 FirstString is not identical to SecondString.
@@ -1383,8 +1383,8 @@ InternalAsciiHexCharToUintn (
than PcdMaximumAsciiStringLength ASCII characters, not including the
Null-terminator, then ASSERT().
@param FirstString Pointer to a Null-terminated ASCII string.
@param SecondString Pointer to a Null-terminated ASCII string.
@param FirstString A pointer to a Null-terminated ASCII string.
@param SecondString A pointer to a Null-terminated ASCII string.
@retval ==0 FirstString is identical to SecondString using case insensitive
comparisons.
@@ -1442,8 +1442,8 @@ AsciiStriCmp (
PcdMaximumAsciiStringLength ASCII characters, not including the Null-terminator,
then ASSERT().
@param FirstString Pointer to a Null-terminated ASCII string.
@param SecondString Pointer to a Null-terminated ASCII string.
@param FirstString A pointer to a Null-terminated ASCII string.
@param SecondString A pointer to a Null-terminated ASCII string.
@param Length Maximum number of ASCII characters for compare.
@retval ==0 FirstString is identical to SecondString.
@@ -1503,8 +1503,8 @@ AsciiStrnCmp (
Source results in a ASCII string with more than PcdMaximumAsciiStringLength
ASCII characters, then ASSERT().
@param Destination Pointer to a Null-terminated ASCII string.
@param Source Pointer to a Null-terminated ASCII string.
@param Destination A pointer to a Null-terminated ASCII string.
@param Source A pointer to a Null-terminated ASCII string.
@return Destination
@@ -1554,8 +1554,8 @@ AsciiStrCat (
Source results in a ASCII string with more than PcdMaximumAsciiStringLength
ASCII characters, not including the Null-terminator, then ASSERT().
@param Destination Pointer to a Null-terminated ASCII string.
@param Source Pointer to a Null-terminated ASCII string.
@param Destination A pointer to a Null-terminated ASCII string.
@param Source A pointer to a Null-terminated ASCII string.
@param Length Maximum number of ASCII characters to concatenate from
Source.
@@ -1600,8 +1600,8 @@ AsciiStrnCat (
String contains more than PcdMaximumAsciiStringLength Unicode characters
not including the Null-terminator, then ASSERT().
@param String Pointer to a Null-terminated ASCII string.
@param SearchString Pointer to a Null-terminated ASCII string to search for.
@param String A pointer to a Null-terminated ASCII string.
@param SearchString A pointer to a Null-terminated ASCII string to search for.
@retval NULL If the SearchString does not appear in String.
@retval others If there is a match return the first occurrence of SearchingString.
@@ -1677,7 +1677,7 @@ AsciiStrStr (
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
then ASSERT().
@param String Pointer to a Null-terminated ASCII string.
@param String A pointer to a Null-terminated ASCII string.
@retval Value translated from String.
@@ -1754,7 +1754,7 @@ AsciiStrDecimalToUintn (
PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
then ASSERT().
@param String Pointer to a Null-terminated ASCII string.
@param String A pointer to a Null-terminated ASCII string.
@retval Value translated from String.
@@ -1834,7 +1834,7 @@ AsciiStrDecimalToUint64 (
and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
the Null-terminator, then ASSERT().
@param String Pointer to a Null-terminated ASCII string.
@param String A pointer to a Null-terminated ASCII string.
@retval Value translated from String.
@@ -1926,7 +1926,7 @@ AsciiStrHexToUintn (
and String contains more than PcdMaximumAsciiStringLength ASCII characters not including
the Null-terminator, then ASSERT().
@param String Pointer to a Null-terminated ASCII string.
@param String A pointer to a Null-terminated ASCII string.
@retval Value translated from String.
@@ -2014,8 +2014,8 @@ AsciiStrHexToUint64 (
PcdMaximumUnicodeStringLength ASCII characters not including the
Null-terminator, then ASSERT().
@param Source Pointer to a Null-terminated ASCII string.
@param Destination Pointer to a Null-terminated Unicode string.
@param Source A pointer to a Null-terminated ASCII string.
@param Destination A pointer to a Null-terminated Unicode string.
@return Destination.