summaryrefslogtreecommitdiffstats
path: root/MdePkg/Library/BaseUefiDecompressLib
diff options
context:
space:
mode:
authormyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>2010-06-30 00:13:25 +0000
committermyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>2010-06-30 00:13:25 +0000
commit58380e9c6174f23df78f777b4209c0fd75245cda (patch)
treea13a3c7c1bd697268c1742659d7148a5d76a55da /MdePkg/Library/BaseUefiDecompressLib
parent3b33c6d65d88da47fe059eff5cd92b39b6d0f42e (diff)
downloadedk2-58380e9c6174f23df78f777b4209c0fd75245cda.tar.gz
edk2-58380e9c6174f23df78f777b4209c0fd75245cda.tar.bz2
edk2-58380e9c6174f23df78f777b4209c0fd75245cda.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@10615 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Library/BaseUefiDecompressLib')
-rw-r--r--MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c22
-rw-r--r--MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h18
2 files changed, 20 insertions, 20 deletions
diff --git a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c
index cd5d8c8d8b..15c3325cd4 100644
--- a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c
+++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c
@@ -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.
diff --git a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h
index 8e5143db7d..358c598c04 100644
--- a/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h
+++ b/MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLibInternals.h
@@ -63,7 +63,7 @@ typedef struct {
///
/// The length of the field 'Position Set Code Length Array Size' in Block Header.
- /// For UEFI 2.0 de/compression algorithm, mPBit = 4
+ /// For UEFI 2.0 de/compression algorithm, mPBit = 4.
///
UINT8 mPBit;
} SCRATCH_DATA;
@@ -73,7 +73,7 @@ typedef struct {
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.
**/
@@ -109,10 +109,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.
@@ -133,7 +133,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.
@@ -172,7 +172,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
@@ -200,7 +200,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