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@10615 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
myronporter
2010-06-30 00:13:25 +00:00
parent 3b33c6d65d
commit 58380e9c61
62 changed files with 1190 additions and 979 deletions

View File

@@ -27,7 +27,7 @@
Shift mBitBuf NumOfBits left. Read in NumOfBits of bits from source.
@param Sd The global scratch data
@param Sd The global scratch data.
@param NumOfBits The number of bits to shift and read.
**/
@@ -119,10 +119,10 @@ GetBits (
and Position Set according to code length array.
If TableBits > 16, then ASSERT ().
@param Sd The global scratch data
@param NumOfChar The number of symbols in the symbol set
@param BitLen Code length array
@param TableBits The width of the mapping table
@param Sd The global scratch data.
@param NumOfChar The number of symbols in the symbol set.
@param BitLen Code length array.
@param TableBits The width of the mapping table.
@param Table The table to be created.
@retval 0 OK.
@@ -262,7 +262,7 @@ MakeTable (
Get a position value according to Position Huffman Table.
@param Sd the global scratch data
@param Sd The global scratch data.
@return The position value decoded.
@@ -401,7 +401,7 @@ ReadPTLen (
Read in and decode the Char&Len Set Code Length Array, then
generate the Huffman Code mapping table for the Char&Len Set.
@param Sd the global scratch data
@param Sd The global scratch data.
**/
VOID
@@ -561,7 +561,7 @@ DecodeC (
/**
Decode the source data and put the resulting data into the destination buffer.
@param Sd The global scratch data
@param Sd The global scratch data.
**/
VOID
@@ -659,13 +659,13 @@ Done:
@param SourceSize The size, in bytes, of the source buffer.
@param DestinationSize A pointer to the size, in bytes, of the uncompressed buffer
that will be generated when the compressed buffer specified
by Source and SourceSize is decompressed..
by Source and SourceSize is decompressed.
@param ScratchSize A pointer to the size, in bytes, of the scratch buffer that
is required to decompress the compressed buffer specified
by Source and SourceSize.
@retval RETURN_SUCCESS The size of the uncompressed data was returned
in DestinationSize and the size of the scratch
in DestinationSize, and the size of the scratch
buffer was returned in ScratchSize.
@retval RETURN_INVALID_PARAMETER
The size of the uncompressed data or the size of
@@ -721,7 +721,7 @@ UefiDecompressGetInfo (
If the required scratch buffer size > 0 and Scratch is NULL, then ASSERT().
@param Source The source buffer containing the compressed data.
@param Destination The destination buffer to store the decompressed data
@param Destination The destination buffer to store the decompressed data.
@param Scratch A temporary scratch buffer that is used to perform the decompression.
This is an optional parameter that may be NULL if the
required scratch buffer size is 0.