Synchronize MdePkg h files to Library/Base* c files.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6984 6f19259b-4bc3-4df7-8a09-765794883524

MdePkg/Include/Library/BaseLib.h

@@ -1817,7 +1817,7 @@ GetPowerOfTwo64 (
 
   @param  Value A 16-bit unsigned value.
 
-  @return The byte swapped value.
+  @return The byte swapped Value.
 
 **/
 UINT16
@@ -1836,7 +1836,7 @@ SwapBytes16 (
 
   @param  Value A 32-bit unsigned value.
 
-  @return The byte swapped value.
+  @return The byte swapped Value.
 
 **/
 UINT32
@@ -1855,7 +1855,7 @@ SwapBytes32 (
 
   @param  Value A 64-bit unsigned value.
 
-  @return The byte swapped value.
+  @return The byte swapped Value.
 
 **/
 UINT64

MdePkg/Library/BaseCacheMaintenanceLib/EbcCache.c

@@ -19,9 +19,6 @@
   Invalidates the entire instruction cache in cache coherency domain of the
   calling CPU.
 
-  Invalidates the entire instruction cache in cache coherency domain of the
-  calling CPU.
-
 **/
 VOID
 EFIAPI

MdePkg/Library/BaseCacheMaintenanceLib/IpfCache.c

@@ -22,9 +22,6 @@
   Invalidates the entire instruction cache in cache coherency domain of the
   calling CPU.
 
-  Invalidates the entire instruction cache in cache coherency domain of the
-  calling CPU.
-
 **/
 VOID
 EFIAPI

MdePkg/Library/BaseCacheMaintenanceLib/X86Cache.c

@@ -27,9 +27,6 @@
   Invalidates the entire instruction cache in cache coherency domain of the
   calling CPU.
 
-  Invalidates the entire instruction cache in cache coherency domain of the
-  calling CPU.
-
 **/
 VOID
 EFIAPI

MdePkg/Library/BaseLib/SwapBytes16.c

@@ -26,7 +26,7 @@
 
   @param  Value A 16-bit unsigned value.
 
-  @return The byte swapped value.
+  @return The byte swapped Value.
 
 **/
 UINT16

MdePkg/Library/BaseMemoryLib/CopyMem.c

@@ -22,8 +22,8 @@
 /**
   Copy Length bytes from Source to Destination.
 
-  @param  Destination Target of copy
+  @param  DestinationBuffer Target of copy
-  @param  Source      Place to copy from
+  @param  SourceBuffer      Place to copy from
   @param  Length            Number of bytes to copy
 
   @return Destination
@@ -32,8 +32,8 @@
 VOID *
 EFIAPI
 InternalMemCopyMem (
-  OUT     VOID                      *Destination,
+  OUT     VOID                      *DestinationBuffer,
-  IN      CONST VOID                *Source,
+  IN      CONST VOID                *SourceBuffer,
   IN      UINTN                     Length
   )
 {
@@ -45,18 +45,18 @@ InternalMemCopyMem (
   volatile UINT8                    *Destination8;
   CONST UINT8                       *Source8;
 
-  if (Source > Destination) {
+  if (SourceBuffer > DestinationBuffer) {
-    Destination8 = (UINT8*)Destination;
+    Destination8 = (UINT8*)DestinationBuffer;
-    Source8 = (CONST UINT8*)Source;
+    Source8 = (CONST UINT8*)SourceBuffer;
     while (Length-- != 0) {
       *(Destination8++) = *(Source8++);
     }
-  } else if (Source < Destination) {
+  } else if (SourceBuffer < DestinationBuffer) {
-    Destination8 = (UINT8*)Destination + Length;
+    Destination8 = (UINT8*)DestinationBuffer + Length;
-    Source8 = (CONST UINT8*)Source + Length;
+    Source8 = (CONST UINT8*)SourceBuffer + Length;
     while (Length-- != 0) {
       *(--Destination8) = *(--Source8);
     }
   }
-  return Destination;
+  return DestinationBuffer;
 }

MdePkg/Library/BasePalLibNull/PalCall.c

@@ -20,9 +20,19 @@
 /**
   Makes a PAL procedure call.
 
-  This is a wrapper function to make a PAL procedure call.
+  This is a wrapper function to make a PAL procedure call.  Based on the Index value,
-  This is just a template as simple instance. It does not
+  this API will make static or stacked PAL call. Architected procedures may be designated
-  make real PAL call. It directly reports error if called.
+  as required or optional.  If a PAL procedure is specified as optional, a unique return
+  code of 0xFFFFFFFFFFFFFFFF is returned in the Status field of the PAL_CALL_RETURN structure.
+  This indicates that the procedure is not present in this PAL implementation.  It is the
+  caller's responsibility to check for this return code after calling any optional PAL
+  procedure. No parameter checking is performed on the 4 input parameters, but there are
+  some common rules that the caller should follow when making a PAL call.  Any address
+  passed to PAL as buffers for return parameters must be 8-byte aligned.  Unaligned addresses
+  may cause undefined results.  For those parameters defined as reserved or some fields
+  defined as reserved must be zero filled or the invalid argument return value may be
+  returned or undefined result may occur during the execution of the procedure.
+  This function is only available on IPF.
 
   @param Index  The PAL procedure Index number.
   @param Arg2   The 2nd parameter for PAL procedure calls.

MdePkg/Library/BasePcdLibNull/PcdLib.c

@@ -20,11 +20,15 @@
 
 
 /**
+  This function provides a means by which SKU support can be established in the PCD infrastructure.
+
   Sets the current SKU in the PCD database to the value specified by SkuId.  SkuId is returned.
 
   @param[in]  SkuId The SKU value that will be used when the PCD service will retrieve and 
                     set values associated with a PCD token.
                     
+  If SkuId >= 0x100, then ASSERT().                  
+
   @return Return the SKU ID that just be set.
 
 **/
@@ -40,6 +44,8 @@ LibPcdSetSku (
 }
 
 /**
+  This function provides a means by which to retrieve a value for a given PCD token.
+  
   Returns the 8-bit value for the token specified by TokenNumber. 
 
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
@@ -61,6 +67,8 @@ LibPcdGet8 (
 
 
 /**
+  This function provides a means by which to retrieve a value for a given PCD token.
+  
   Returns the 16-bit value for the token specified by TokenNumber. 
 
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
@@ -82,6 +90,8 @@ LibPcdGet16 (
 
 
 /**
+  This function provides a means by which to retrieve a value for a given PCD token.
+  
   Returns the 32-bit value for the token specified by TokenNumber. 
 
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
@@ -103,6 +113,8 @@ LibPcdGet32 (
 
 
 /**
+  This function provides a means by which to retrieve a value for a given PCD token.
+  
   Returns the 64-bit value for the token specified by TokenNumber.
 
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
@@ -124,6 +136,8 @@ LibPcdGet64 (
 
 
 /**
+  This function provides a means by which to retrieve a value for a given PCD token.
+  
   Returns the pointer to the buffer of the token specified by TokenNumber.
 
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
@@ -145,6 +159,8 @@ LibPcdGetPtr (
 
 
 /**
+  This function provides a means by which to retrieve a value for a given PCD token.
+  
   Returns the Boolean value of the token specified by TokenNumber. 
 
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
@@ -166,7 +182,7 @@ LibPcdGetBool (
 
 
 /**
-  Returns the size of the token specified by TokenNumber. 
+  This function provides a means by which to retrieve the size of a given PCD token.
 
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
 
@@ -187,7 +203,10 @@ LibPcdGetSize (
 
 
 /**
+  This function provides a means by which to retrieve a value for a given PCD token.
+  
   Returns the 8-bit value for the token specified by TokenNumber and Guid.
+  
   If Guid is NULL, then ASSERT(). 
 
   @param[in]  Guid Pointer to a 128-bit unique value that designates 
@@ -212,7 +231,10 @@ LibPcdGetEx8 (
 
 
 /**
+  This function provides a means by which to retrieve a value for a given PCD token.
+
   Returns the 16-bit value for the token specified by TokenNumber and Guid.
+  
   If Guid is NULL, then ASSERT(). 
 
   @param[in]  Guid Pointer to a 128-bit unique value that designates 
@@ -262,7 +284,10 @@ LibPcdGetEx32 (
 
 
 /**
+  This function provides a means by which to retrieve a value for a given PCD token.
+  
   Returns the 64-bit value for the token specified by TokenNumber and Guid.
+  
   If Guid is NULL, then ASSERT(). 
 
   @param[in]  Guid          Pointer to a 128-bit unique value that designates 
@@ -287,7 +312,10 @@ LibPcdGetEx64 (
 
 
 /**
-  Returns the pointer to the buffer of the token specified by TokenNumber and Guid.
+  This function provides a means by which to retrieve a value for a given PCD token.
+  
+  Returns the pointer to the buffer of token specified by TokenNumber and Guid.
+  
   If Guid is NULL, then ASSERT(). 
 
   @param[in]  Guid          Pointer to a 128-bit unique value that designates 
@@ -312,7 +340,10 @@ LibPcdGetExPtr (
 
 
 /**
+  This function provides a means by which to retrieve a value for a given PCD token.
+  
   Returns the Boolean value of the token specified by TokenNumber and Guid. 
+  
   If Guid is NULL, then ASSERT(). 
 
   @param[in]  Guid          Pointer to a 128-bit unique value that designates 
@@ -337,7 +368,10 @@ LibPcdGetExBool (
 
 
 /**
+  This function provides a means by which to retrieve the size of a given PCD token.
+  
   Returns the size of the token specified by TokenNumber and Guid. 
+  
   If Guid is NULL, then ASSERT(). 
 
   @param[in]  Guid          Pointer to a 128-bit unique value that designates 
@@ -362,6 +396,8 @@ LibPcdGetExSize (
 
 
 /**
+  This function provides a means by which to set a value for a given PCD token.
+  
   Sets the 8-bit value for the token specified by TokenNumber 
   to the value specified by Value.  Value is returned.
   
@@ -386,6 +422,8 @@ LibPcdSet8 (
 
 
 /**
+  This function provides a means by which to set a value for a given PCD token.
+  
   Sets the 16-bit value for the token specified by TokenNumber 
   to the value specified by Value.  Value is returned.
   
@@ -410,6 +448,8 @@ LibPcdSet16 (
 
 
 /**
+  This function provides a means by which to set a value for a given PCD token.
+  
   Sets the 32-bit value for the token specified by TokenNumber 
   to the value specified by Value.  Value is returned.
   
@@ -434,6 +474,8 @@ LibPcdSet32 (
 
 
 /**
+  This function provides a means by which to set a value for a given PCD token.
+  
   Sets the 64-bit value for the token specified by TokenNumber 
   to the value specified by Value.  Value is returned.
   
@@ -458,18 +500,19 @@ LibPcdSet64 (
 
 
 /**
-  Sets a buffer for the token specified by TokenNumber to 
+  This function provides a means by which to set a value for a given PCD token.
-  the value specified by Buffer and SizeOfValue.  Buffer to
-  be set is returned. The content of the buffer could be 
-  overwritten if a Callback on SET is registered with this
-  TokenNumber.
   
-  If SizeOfValue is greater than the maximum 
+  Sets a buffer for the token specified by TokenNumber to the value 
-  size support by TokenNumber, then set SizeOfValue to the 
+  specified by Buffer and SizeOfBuffer.  Buffer is returned.  
-  maximum size supported by TokenNumber and return NULL to 
+  If SizeOfBuffer is greater than the maximum size support by TokenNumber, 
-  indicate that the set operation was not actually performed. 
+  then set SizeOfBuffer to the maximum size supported by TokenNumber and 
+  return NULL to indicate that the set operation was not actually performed.  
 
-  If SizeOfValue > 0 and Buffer is NULL, then ASSERT().
+  If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the 
+  maximum size supported by TokenName and NULL must be returned.
+  
+  If SizeOfBuffer is NULL, then ASSERT().
+  If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
   
   @param[in]      TokenNumber   The PCD token number to set a current value for.
   @param[in, out] SizeOfBuffer  The size, in bytes, of Buffer.
@@ -494,6 +537,8 @@ LibPcdSetPtr (
 
 
 /**
+  This function provides a means by which to set a value for a given PCD token.
+  
   Sets the Boolean value for the token specified by TokenNumber 
   to the value specified by Value.  Value is returned.
   
@@ -518,8 +563,11 @@ LibPcdSetBool (
 
 
 /**
+  This function provides a means by which to set a value for a given PCD token.
+  
   Sets the 8-bit value for the token specified by TokenNumber and 
   Guid to the value specified by Value. Value is returned.
+  
   If Guid is NULL, then ASSERT().
   
   @param[in]  Guid          Pointer to a 128-bit unique value that 
@@ -546,8 +594,11 @@ LibPcdSetEx8 (
 
 
 /**
+  This function provides a means by which to set a value for a given PCD token.
+  
   Sets the 16-bit value for the token specified by TokenNumber and 
   Guid to the value specified by Value. Value is returned.
+  
   If Guid is NULL, then ASSERT().
   
   @param[in]  Guid          Pointer to a 128-bit unique value that 
@@ -574,8 +625,11 @@ LibPcdSetEx16 (
 
 
 /**
+  This function provides a means by which to set a value for a given PCD token.
+  
   Sets the 32-bit value for the token specified by TokenNumber and 
   Guid to the value specified by Value. Value is returned.
+  
   If Guid is NULL, then ASSERT().
   
   @param[in]  Guid          Pointer to a 128-bit unique value that 
@@ -602,6 +656,8 @@ LibPcdSetEx32 (
 
 
 /**
+  This function provides a means by which to set a value for a given PCD token.
+  
   Sets the 64-bit value for the token specified by TokenNumber and 
   Guid to the value specified by Value. Value is returned.
   If Guid is NULL, then ASSERT().
@@ -630,13 +686,17 @@ LibPcdSetEx64 (
 
 
 /**
+  This function provides a means by which to set a value for a given PCD token.
+  
   Sets a buffer for the token specified by TokenNumber to the value specified by 
-  Buffer and SizeOfValue.  Buffer is returned.  If SizeOfValue is greater than 
+  Buffer and SizeOfBuffer.  Buffer is returned.  If SizeOfBuffer is greater than 
-  the maximum size support by TokenNumber, then set SizeOfValue to the maximum size 
+  the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size 
   supported by TokenNumber and return NULL to indicate that the set operation 
   was not actually performed. 
   
-  If SizeOfValue > 0 and Buffer is NULL, then ASSERT().
+  If Guid is NULL, then ASSERT().
+  If SizeOfBuffer is NULL, then ASSERT().
+  If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
   
   @param[in]  Guid              Pointer to a 128-bit unique value that 
                                 designates which namespace to set a value from.
@@ -664,8 +724,11 @@ LibPcdSetExPtr (
 
 
 /**
+  This function provides a means by which to set a value for a given PCD token.
+  
   Sets the Boolean value for the token specified by TokenNumber and 
   Guid to the value specified by Value. Value is returned.
+  
   If Guid is NULL, then ASSERT().
   
   @param[in]  Guid          Pointer to a 128-bit unique value that 
@@ -692,9 +755,12 @@ LibPcdSetExBool (
 
 
 /**
+  Set up a notification function that is called when a specified token is set.
+  
   When the token specified by TokenNumber and Guid is set, 
   then notification function specified by NotificationFunction is called.  
   If Guid is NULL, then the default token space is used. 
+  
   If NotificationFunction is NULL, then ASSERT().
 
   @param[in]  Guid      Pointer to a 128-bit unique value that designates which 
@@ -720,7 +786,12 @@ LibPcdCallbackOnSet (
 
 /**
   Disable a notification function that was established with LibPcdCallbackonSet().
+  
+  Disable a notification function that was previously established with LibPcdCallbackOnSet(). 
+  
   If NotificationFunction is NULL, then ASSERT().
+  If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber, 
+  and NotificationFunction, then ASSERT().
   
   @param[in]  Guid          Specify the GUID token space.
   @param[in]  TokenNumber   Specify the token number.
@@ -741,12 +812,15 @@ LibPcdCancelCallback (
 
 
 /**
+  Retrieves the next token in a token space.
+  
   Retrieves the next PCD token number from the token space specified by Guid.  
   If Guid is NULL, then the default token space is used.  If TokenNumber is 0, 
   then the first token number is returned.  Otherwise, the token number that 
   follows TokenNumber in the token space is returned.  If TokenNumber is the last 
-  token number in the token space, then 0 is returned.  If TokenNumber is not 0 and 
+  token number in the token space, then 0 is returned.  
-  is not in the token space specified by Guid, then ASSERT().
+  
+  If TokenNumber is not 0 and is not in the token space specified by Guid, then ASSERT().
 
   @param[in]  Guid        Pointer to a 128-bit unique value that designates which namespace 
                           to set a value from.  If NULL, then the default token space is used.
@@ -771,6 +845,8 @@ LibPcdGetNextToken (
 
 
 /**
+  Used to retrieve the list of available PCD token space GUIDs.
+  
   Retrieves the next PCD token space from a token space specified by Guid.
   Guid of NULL is reserved to mark the default local token namespace on the current
   platform. If Guid is NULL, then the GUID of the first non-local token space of the 
@@ -779,6 +855,8 @@ LibPcdGetNextToken (
 
   If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().
 
+
+  
   @param[in]  Guid  Pointer to a 128-bit unique value that designates from which namespace 
                     to start the search.
 
@@ -788,7 +866,7 @@ LibPcdGetNextToken (
 GUID *           
 EFIAPI
 LibPcdGetNextTokenSpace (
-  IN CONST GUID  *Guid
+  IN CONST GUID  *TokenSpaceGuid
   )
 {
   ASSERT (FALSE);

MdePkg/Library/BasePciLibCf8/PciLib.c

@@ -1108,7 +1108,7 @@ PciReadBuffer (
   @param  Size          Size in bytes of the transfer.
   @param  Buffer        Pointer to a buffer containing the data to write.
 
-  @return Size
+  @return Size written to StartAddress.
 
 **/
 UINTN

MdePkg/Library/BasePciLibPciExpress/PciLib.c

@@ -1108,7 +1108,7 @@ PciReadBuffer (
   @param  Size          Size in bytes of the transfer.
   @param  Buffer        Pointer to a buffer containing the data to write.
 
-  @return Size
+  @return Size written to StartAddress.
 
 **/
 UINTN

MdePkg/Library/BasePeCoffLib/BasePeCoff.c

@@ -487,6 +487,12 @@ PeCoffLoaderImageAddress (
   ImageContext as the relocation base address.  Otherwise, use the DestinationAddress field
   of ImageContext as the relocation base address.  The caller must allocate the relocation
   fixup log buffer and fill in the FixupData field of ImageContext prior to calling this function.
+  
+  The ImageRead, Handle, PeCoffHeaderOffset,  IsTeImage, Machine, ImageType, ImageAddress, 
+  ImageSize, DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, 
+  DebugDirectoryEntryRva, EntryPoint, FixupDataSize, CodeView, PdbPointer, and FixupData of 
+  the ImageContext structure must be valid prior to invoking this service.
+    
   If ImageContext is NULL, then ASSERT().
 
   @param  ImageContext        Pointer to the image context structure that describes the PE/COFF
@@ -725,6 +731,10 @@ PeCoffLoaderRelocateImage (
   specified by the ImageAddress and ImageSize fields of ImageContext.  The caller must allocate
   the load buffer and fill in the ImageAddress and ImageSize fields prior to calling this function.
   The EntryPoint, FixupDataSize, CodeView, and PdbPointer fields of ImageContext are computed.
+  The ImageRead, Handle, PeCoffHeaderOffset,  IsTeImage,  Machine, ImageType, ImageAddress, ImageSize, 
+  DestinationAddress, RelocationsStripped, SectionAlignment, SizeOfHeaders, and DebugDirectoryEntryRva 
+  fields of the ImageContext structure must be valid prior to invoking this service.
+  
   If ImageContext is NULL, then ASSERT().
 
   @param  ImageContext              Pointer to the image context structure that describes the PE/COFF
@@ -1123,10 +1133,13 @@ PeCoffLoaderLoadImage (
   the fixups with a virtual mapping.
 
 
-  @param  ImageBase          Base address of relocated image
+  @param  ImageBase          Base address of a PE/COFF image that has been loaded 
-  @param  VirtImageBase      Virtual mapping for ImageBase
+                             and relocated into system memory.
-  @param  ImageSize          Size of the image to relocate
+  @param  VirtImageBase      The request virtual address that the PE/COFF image is to
-  @param  RelocationData     Location to place results of read
+                             be fixed up for.
+  @param  ImageSize          The size, in bytes, of the PE/COFF image.
+  @param  RelocationData     A pointer to the relocation data that was collected when the PE/COFF 
+                             image was relocated using PeCoffLoaderRelocateImage().
   
 **/
 VOID
@@ -1360,11 +1373,15 @@ PeCoffLoaderImageReadFromMemory (
 
 /**
   Unloads a loaded PE/COFF image from memory and releases its taken resource.
+  Releases any environment specific resources that were allocated when the image 
+  specified by ImageContext was loaded using PeCoffLoaderLoadImage(). 
  
   For NT32 emulator, the PE/COFF image loaded by system needs to release.
   For real platform, the PE/COFF image loaded by Core doesn't needs to be unloaded, 
   this function can simply return RETURN_SUCCESS.
   
+  If ImageContext is NULL, then ASSERT().
+  
   @param  ImageContext              Pointer to the image context structure that describes the PE/COFF
                                     image to be unloaded.
 

MdePkg/Library/BasePeCoffLib/PeCoffLoaderEx.c

@@ -16,14 +16,15 @@
 
 
 /**
-  Performs an IA-32 specific relocation fixup.
+  Performs an Itanium-based specific relocation fixup and is a no-op on other
+  instruction sets.
 
   @param  Reloc       Pointer to the relocation record.
   @param  Fixup       Pointer to the address to fix up.
   @param  FixupData   Pointer to a buffer to log the fixups.
   @param  Adjust      The offset to adjust the fixup.
 
-  @retval EFI_UNSUPPORTED Unsupported now.
+  @return Status code.
 
 **/
 RETURN_STATUS
@@ -43,10 +44,6 @@ PeCoffLoaderRelocateImageEx (
   loading and relocating of the image type. It's up to the caller to support
   the entry point.
 
-  This function implies the basic PE/COFF loader/relocator supports IA32, EBC,
-  & x64 images. Calling the entry point in a correct mannor is up to the 
-  consumer of this library.
-
   @param  Machine   Machine type from the PE Header.
 
   @return TRUE if this PE/COFF loader can load the image
@@ -75,7 +72,7 @@ PeCoffLoaderImageFormatSupported (
   @param  FixupData   Pointer to a buffer to log the fixups.
   @param  Adjust      The offset to adjust the fixup.
 
-  @return Always return UNSUPPORTED.
+  @return Status code.
 
 **/
 RETURN_STATUS

MdePkg/Library/BasePostCodeLibPort80/PostCode.c

@@ -66,7 +66,7 @@ PostCode (
   @param  Value        The 32-bit value to write to the POST card.
   @param  Description  Pointer to an ASCII string that is a description of the 
                        POST code value.  This is an optional parameter that may 
-                       be NULL. Ihis parameter is ignored in this implementation. 
+                       be NULL.
 
   @return The 32-bit value to write to the POST card.
 

MdePkg/Library/BasePrintLib/PrintLibInternal.c

@@ -131,7 +131,7 @@ BasePrintLibValueToString (
   Converts the decimal number specified by Value to a Null-terminated  
   string specified by Buffer containing at most Width characters.
   If Width is 0 then a width of  MAXIMUM_VALUE_CHARACTERS is assumed.
-  The number of characters in Buffer is returned not including the Null-terminator.
+  The total number of characters placed in Buffer is returned.
   If the conversion contains more than Width characters, then only the first
   Width characters are returned, and the total number of characters 
   required to perform the conversion is returned.
@@ -141,13 +141,11 @@ BasePrintLibValueToString (
   If Width is 0, PREFIX_ZERO is ignored in Flags.
   If COMMA_TYPE is set in Flags, then PREFIX_ZERO is ignored in Flags, and commas
   are inserted every 3rd digit starting from the right.
-  If HEX_RADIX is set in Flags, then the output buffer will be formatted in hexadecimal format.
+  If Value is < 0, then the fist character in Buffer is a '-'.
-  If Value is < 0 and HEX_RADIX is not set in Flags, then the fist character in Buffer is a '-'.
   If PREFIX_ZERO is set in Flags and PREFIX_ZERO is not being ignored, 
   then Buffer is padded with '0' characters so the combination of the optional '-' 
   sign character, '0' characters, digit characters for Value, and the Null-terminator
   add up to Width characters.
-  If both COMMA_TYPE and HEX_RADIX are set in Flags, then ASSERT().
 
   If Buffer is NULL, then ASSERT().
   If unsupported bits are set in Flags, then ASSERT().
@@ -162,7 +160,7 @@ BasePrintLibValueToString (
                     the Null-terminator.
   @param  Increment Character increment in Buffer.
   
-  @return The number of characters in Buffer not including the Null-terminator.
+  @return Total number of characters required to perform the conversion.
 
 **/
 UINTN
@@ -792,7 +790,7 @@ BasePrintLibVSPrint (
 
   VSPrint function to process format and place the results in Buffer. Since a 
   VA_LIST is used this rountine allows the nesting of Vararg routines. Thus 
-  this is the main print working routine.
+  this is the main print working routine
 
   @param  StartOfBuffer Character buffer to print the results of the parsing
                         of Format into.
@@ -803,7 +801,7 @@ BasePrintLibVSPrint (
   @param  FormatString  Null-terminated format string.
   @param  ...           The variable argument list.
 
-  @return Number of characters printed not including the Null-terminator.
+  @return Number of characters printed.
 
 **/
 UINTN

MdePkg/Library/BaseUefiDecompressLib/BaseUefiDecompressLib.c

@@ -122,7 +122,7 @@ GetBits (
   @param  NumOfChar 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
+  @param  Table     The table to be created.
 
   @retval  0 OK.
   @retval  BAD_TABLE The table is corrupted.