Synchronize function comment in MdePkg\Library\BaseLib.h with the instance of this functions.

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

MdePkg/Include/Library/BaseLib.h

@@ -148,7 +148,7 @@ typedef struct {
   @param  Destination Pointer to a Null-terminated Unicode string.
   @param  Source      Pointer to a Null-terminated Unicode string.
 
-  @return Destiantion
+  @return Destination.
 
 **/
 CHAR16 *
@@ -184,7 +184,7 @@ StrCpy (
   @param  Source      Pointer to a Null-terminated Unicode string.
   @param  Length      Maximum number of Unicode characters to copy.
 
-  @return Destination
+  @return Destination.
 
 **/
 CHAR16 *
@@ -349,7 +349,7 @@ StrnCmp (
   @param  Destination Pointer to a Null-terminated Unicode string.
   @param  Source      Pointer to a Null-terminated Unicode string.
 
-  @return Destination
+  @return Destination.
 
 **/
 CHAR16 *
@@ -394,7 +394,7 @@ StrCat (
   @param  Length      Maximum number of Unicode characters to concatenate from
                       Source.
 
-  @return Destination
+  @return Destination.
 
 **/
 CHAR16 *
@@ -406,7 +406,7 @@ StrnCat (
   );
 
 /**
-  Returns the first occurance of a Null-terminated Unicode sub-string
+  Returns the first occurrence of a Null-terminated Unicode sub-string
   in a Null-terminated Unicode string.
 
   This function scans the contents of the Null-terminated Unicode string
@@ -634,7 +634,7 @@ NibbleToHexChar (
   the last character in the output string. The one next to first byte will be put into the
   character before the last character. This rules applies to the rest of the bytes. The Unicode
   character by the last byte will be put into the first character in the output string. For example,
-  the input buffer for a 64-bits unsigned integrer 0x12345678abcdef1234 will be converted to
+  the input buffer for a 64-bits unsigned integer 0x12345678abcdef1234 will be converted to
   a Unicode string equal to L"12345678abcdef1234".
 
   @param String                        On input, String is pointed to the buffer allocated for the convertion.
@@ -642,10 +642,10 @@ NibbleToHexChar (
                                        The StringLen required to convert a N bytes Buffer will be a least equal to or greater 
                                        than 2*N + 1.
   @param Buffer                        The pointer to a input buffer.
-  @param BufferSizeInBytes             Lenth in bytes of the input buffer.
+  @param BufferSizeInBytes             Length in bytes of the input buffer.
   
 
-  @retval  EFI_SUCCESS                 The convertion is successfull. All bytes in Buffer has been convert to the corresponding
+  @retval  EFI_SUCCESS                 The convertion is successful. All bytes in Buffer has been convert to the corresponding
                                        Unicode character and placed into the right place in String.
   @retval  EFI_BUFFER_TOO_SMALL        StringSizeInBytes is smaller than 2 * N + 1the number of bytes required to
                                        complete the convertion. 
@@ -758,7 +758,7 @@ IsHexDigit (
   @param  Source        Pointer to a Null-terminated Unicode string.
   @param  Destination   Pointer to a Null-terminated ASCII string.
 
-  @return Destination
+  @return Destination.
 
 **/
 CHAR8 *
@@ -1067,7 +1067,7 @@ AsciiStrnCat (
 
 
 /**
-  Returns the first occurance of a Null-terminated ASCII sub-string
+  Returns the first occurrence of a Null-terminated ASCII sub-string
   in a Null-terminated ASCII string.
 
   This function scans the contents of the ASCII string specified by String
@@ -1087,7 +1087,7 @@ AsciiStrnCat (
 
   @retval NULL            If the SearchString does not appear in String.
   @retval others          If there is a match return the first occurrence of SearchingString.
-                          If the lenth of SearchString is zero,return String.
+                          If the length of SearchString is zero,return String.
 
 **/
 CHAR8 *
@@ -1278,7 +1278,7 @@ AsciiStrHexToUint64 (
   @param  Source        Pointer to a Null-terminated ASCII string.
   @param  Destination   Pointer to a Null-terminated Unicode string.
 
-  @return Destination
+  @return Destination.
 
 **/
 CHAR16 *
@@ -1299,7 +1299,7 @@ AsciiStrToUnicodeStr (
 
   @param  Value The 8-bit value to convert to BCD. Range 0..99.
 
-  @return The BCD value
+  @return The BCD value.
 
 **/
 UINT8
@@ -1603,7 +1603,7 @@ IsNodeAtEnd (
   @param  FirstEntry  A pointer to a node in a linked list.
   @param  SecondEntry A pointer to another node in the same linked list.
   
-  @return SecondEntry
+  @return SecondEntry.
 
 **/
 LIST_ENTRY *
@@ -1630,9 +1630,9 @@ SwapListEntries (
   linked list containing Entry, including the Entry node, is greater than
   or equal to PcdMaximumLinkedListLength, then ASSERT().
 
-  @param  Entry A pointer to a node in a linked list
+  @param  Entry A pointer to a node in a linked list.
 
-  @return Entry
+  @return Entry.
 
 **/
 LIST_ENTRY *
@@ -1657,7 +1657,7 @@ RemoveEntryList (
   @param  Operand The 64-bit operand to shift left.
   @param  Count   The number of bits to shift left.
 
-  @return Operand << Count
+  @return Operand << Count.
 
 **/
 UINT64
@@ -1819,7 +1819,7 @@ RRotU64 (
 
   @param  Operand The 32-bit operand to evaluate.
 
-  @retval 0-31  The lowest bit set in Operand was found.
+  @retval 0..31  The lowest bit set in Operand was found.
   @retval -1    Operand is zero.
 
 **/
@@ -1839,7 +1839,7 @@ LowBitSet32 (
 
   @param  Operand The 64-bit operand to evaluate.
 
-  @retval 0-63  The lowest bit set in Operand was found.
+  @retval 0..63  The lowest bit set in Operand was found.
   @retval -1    Operand is zero.
 
 
@@ -1861,7 +1861,7 @@ LowBitSet64 (
 
   @param  Operand The 32-bit operand to evaluate.
 
-  @retval 0-31  Position of the highest bit set in Operand if found.
+  @retval 0..31  Position of the highest bit set in Operand if found.
   @retval -1    Operand is zero.
 
 **/
@@ -1882,7 +1882,7 @@ HighBitSet32 (
 
   @param  Operand The 64-bit operand to evaluate.
 
-  @retval 0-63   Position of the highest bit set in Operand if found.
+  @retval 0..63   Position of the highest bit set in Operand if found.
   @retval -1     Operand is zero.
 
 **/
@@ -2175,7 +2175,7 @@ DivU64x64Remainder (
   NULL, then the 64-bit signed remainder is returned in Remainder. This
   function returns the 64-bit signed quotient.
 
-  It is the caller¡¯s responsibility to not call this function with a Divisor of 0.
+  It is the caller's responsibility to not call this function with a Divisor of 0.
   If Divisor is 0, then the quotient and remainder should be assumed to be 
   the largest negative integer.
 
@@ -3089,7 +3089,7 @@ InitializeSpinLock (
 
   @param  SpinLock  A pointer to the spin lock to place in the acquired state.
 
-  @return SpinLock accquired lock.
+  @return SpinLock acquired lock.
 
 **/
 SPIN_LOCK *

MdePkg/Library/BaseLib/ARShiftU64.c

@@ -26,7 +26,7 @@
   @param  Operand The 64-bit operand to shift right.
   @param  Count   The number of bits to shift right.
 
-  @return Operand arithmetically shifted right by Count
+  @return Operand >> Count
 
 **/
 UINT64

MdePkg/Library/BaseLib/CheckSum.c

@@ -16,7 +16,7 @@
 #include "BaseLibInternals.h"
 
 /**
-  Calculate the sum of all elements in a buffer in unit of UINT8. 
+  Returns the sum of all elements in a buffer in unit of UINT8.
   During calculation, the carry bits are dropped.
 
   This function calculates the sum of all elements in a buffer
@@ -28,9 +28,9 @@
   If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
 
   @param  Buffer      Pointer to the buffer to carry out the sum operation.
-  @param  Length      The size, in bytes, of Buffer .
+  @param  Length      The size, in bytes, of Buffer.
 
-  @return The sum of Buffer with carry bits dropped during additions.
+  @return Sum         The sum of Buffer with carry bits dropped during additions.
 
 **/
 UINT8
@@ -69,7 +69,7 @@ CalculateSum8 (
   @param  Buffer      Pointer to the buffer to carry out the checksum operation.
   @param  Length      The size, in bytes, of Buffer.
 
-  @return The 2's complement checksum of Buffer.
+  @return Checksum    The 2's complement checksum of Buffer.
 
 **/
 UINT8
@@ -105,7 +105,7 @@ CalculateCheckSum8 (
   @param  Buffer      Pointer to the buffer to carry out the sum operation.
   @param  Length      The size, in bytes, of Buffer.
 
-  @return The sum of Buffer with carry bits dropped during additions.
+  @return Sum         The sum of Buffer with carry bits dropped during additions.
 
 **/
 UINT16
@@ -150,7 +150,7 @@ CalculateSum16 (
   @param  Buffer      Pointer to the buffer to carry out the checksum operation.
   @param  Length      The size, in bytes, of Buffer.
 
-  @return The 2's complement checksum of Buffer.
+  @return Checksum    The 2's complement checksum of Buffer.
 
 **/
 UINT16
@@ -187,7 +187,7 @@ CalculateCheckSum16 (
   @param  Buffer      Pointer to the buffer to carry out the sum operation.
   @param  Length      The size, in bytes, of Buffer.
 
-  @return The sum of Buffer with carry bits dropped during additions.
+  @return Sum         The sum of Buffer with carry bits dropped during additions.
 
 **/
 UINT32
@@ -232,7 +232,7 @@ CalculateSum32 (
   @param  Buffer      Pointer to the buffer to carry out the checksum operation.
   @param  Length      The size, in bytes, of Buffer.
 
-  @return The 2's complement checksum of Buffer.
+  @return Checksum    The 2's complement checksum of Buffer.
 
 **/
 UINT32
@@ -269,7 +269,7 @@ CalculateCheckSum32 (
   @param  Buffer      Pointer to the buffer to carry out the sum operation.
   @param  Length      The size, in bytes, of Buffer.
 
-  @return The sum of Buffer with carry bits dropped during additions.
+  @return Sum         The sum of Buffer with carry bits dropped during additions.
 
 **/
 UINT64
@@ -314,7 +314,7 @@ CalculateSum64 (
   @param  Buffer      Pointer to the buffer to carry out the checksum operation.
   @param  Length      The size, in bytes, of Buffer.
 
-  @return The 2's complement checksum of Buffer.
+  @return Checksum    The 2's complement checksum of Buffer.
 
 **/
 UINT64

MdePkg/Library/BaseLib/Cpu.c

@@ -47,7 +47,7 @@ SaveAndDisableInterrupts (
   @param  InterruptState  TRUE if interrupts should enabled. FALSE if
                           interrupts should be disabled.
 
-  @return Input interrupt status to be set.
+  @return InterruptState
 
 **/
 BOOLEAN

MdePkg/Library/BaseLib/DivS64x64Remainder.c

@@ -26,6 +26,10 @@
   NULL, then the 64-bit signed remainder is returned in Remainder. This
   function returns the 64-bit signed quotient.
 
+  It is the caller¡¯s responsibility to not call this function with a Divisor of 0.
+  If Divisor is 0, then the quotient and remainder should be assumed to be 
+  the largest negative integer.
+
   If Divisor is 0, then ASSERT().
 
   @param  Dividend  A 64-bit signed value.

MdePkg/Library/BaseLib/Ebc/CpuBreakpoint.c

@@ -80,8 +80,8 @@ EnableInterrupts (
 /**
   Retrieves the current CPU interrupt state.
 
-  Retrieves the current CPU interrupt state. Returns TRUE is interrupts are
+  Returns TRUE is interrupts are currently enabled. Otherwise
-  currently enabled. Otherwise returns FALSE.
+  returns FALSE.
 
   @retval TRUE  CPU interrupts are enabled.
   @retval FALSE CPU interrupts are disabled.

MdePkg/Library/BaseLib/GetPowerOfTwo32.c

@@ -19,7 +19,7 @@
 
 /**
   Returns the value of the highest bit set in a 32-bit value. Equivalent to
-  1 << HighBitSet32(x).
+  1 << log2(x).
 
   This function computes the value of the highest bit set in the 32-bit value
   specified by Operand. If Operand is zero, then zero is returned.

MdePkg/Library/BaseLib/GetPowerOfTwo64.c

@@ -19,7 +19,7 @@
 
 /**
   Returns the value of the highest bit set in a 64-bit value. Equivalent to
-  1 << HighBitSet64(x).
+  1 << log2(x).
 
   This function computes the value of the highest bit set in the 64-bit value
   specified by Operand. If Operand is zero, then zero is returned.

MdePkg/Library/BaseLib/HighBitSet32.c

@@ -27,7 +27,7 @@
 
   @param  Operand The 32-bit operand to evaluate.
 
-  @return Position of the highest bit set in Operand if found.
+  @retval 0..31  Position of the highest bit set in Operand if found.
   @retval -1    Operand is zero.
 
 **/

MdePkg/Library/BaseLib/HighBitSet64.c

@@ -27,7 +27,7 @@
 
   @param  Operand The 64-bit operand to evaluate.
 
-  @return Position of the highest bit set in Operand if found.
+  @retval 0..63   Position of the highest bit set in Operand if found.
   @retval -1     Operand is zero.
 
 **/

MdePkg/Library/BaseLib/LRotU32.c

@@ -27,7 +27,7 @@
   @param  Operand The 32-bit operand to rotate left.
   @param  Count   The number of bits to rotate left.
 
-  @return Operand <<< Count
+  @return Operand << Count
 
 **/
 UINT32

MdePkg/Library/BaseLib/LRotU64.c

@@ -27,7 +27,7 @@
   @param  Operand The 64-bit operand to rotate left.
   @param  Count   The number of bits to rotate left.
 
-  @return Operand <<< Count
+  @return Operand << Count
 
 **/
 UINT64

MdePkg/Library/BaseLib/LShiftU64.c

@@ -26,7 +26,7 @@
   @param  Operand The 64-bit operand to shift left.
   @param  Count   The number of bits to shift left.
 
-  @return Operand << Count
+  @return Operand << Count.
 
 **/
 UINT64

MdePkg/Library/BaseLib/LinkedList.c

@@ -85,7 +85,7 @@ IsNodeInList (
 
   If ListHead is NULL, then ASSERT().
 
-  @param  List  A pointer to the head node of a new doubly linked list.
+  @param  ListHead  A pointer to the head node of a new doubly linked list.
 
   @return ListHead
 
@@ -113,12 +113,13 @@ InitializeListHead (
 
   If ListHead is NULL, then ASSERT().
   If Entry is NULL, then ASSERT().
-  If ListHead was not initialized with InitializeListHead(), then ASSERT().
+  If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
+  InitializeListHead(), then ASSERT().
   If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
   of nodes in ListHead, including the ListHead node, is greater than or
   equal to PcdMaximumLinkedListLength, then ASSERT().
 
-  @param  List      A pointer to the head node of a doubly linked list.
+  @param  ListHead  A pointer to the head node of a doubly linked list.
   @param  Entry     A pointer to a node that is to be inserted at the beginning
                     of a doubly linked list.
 
@@ -153,12 +154,13 @@ InsertHeadList (
 
   If ListHead is NULL, then ASSERT().
   If Entry is NULL, then ASSERT().
-  If ListHead was not initialized with InitializeListHead(), then ASSERT().
+  If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or 
+  InitializeListHead(), then ASSERT().
   If PcdMaximumLinkedListLenth is not zero, and prior to insertion the number
   of nodes in ListHead, including the ListHead node, is greater than or
   equal to PcdMaximumLinkedListLength, then ASSERT().
 
-  @param  List      A pointer to the head node of a doubly linked list.
+  @param  ListHead  A pointer to the head node of a doubly linked list.
   @param  Entry     A pointer to a node that is to be added at the end of the
                     doubly linked list.
 
@@ -188,11 +190,12 @@ InsertTailList (
   Retrieves the first node of a doubly linked list.
 
   Returns the first node of a doubly linked list.  List must have been 
-  initialized with InitializeListHead(). If List is empty, then NULL is
+  initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
-  returned.
+  If List is empty, then List is returned.
 
   If List is NULL, then ASSERT().
-  If List was not initialized with InitializeListHead(), then ASSERT().
+  If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or 
+  InitializeListHead(), then ASSERT().
   If PcdMaximumLinkedListLenth is not zero, and the number of nodes
   in List, including the List node, is greater than or equal to
   PcdMaximumLinkedListLength, then ASSERT().
@@ -220,13 +223,14 @@ GetFirstNode (
 /**
   Retrieves the next node of a doubly linked list.
 
-  Returns the node of a doubly linked list that follows Node. List must have
+  Returns the node of a doubly linked list that follows Node.  
-  been initialized with InitializeListHead(). If List is empty, then List is
+  List must have been initialized with INTIALIZE_LIST_HEAD_VARIABLE()
-  returned.
+  or InitializeListHead().  If List is empty, then List is returned.
 
   If List is NULL, then ASSERT().
   If Node is NULL, then ASSERT().
-  If List was not initialized with InitializeListHead(), then ASSERT().
+  If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or 
+  InitializeListHead(), then ASSERT().
   If PcdMaximumLinkedListLenth is not zero, and List contains more than
   PcdMaximumLinkedListLenth nodes, then ASSERT().
   If Node is not a node in List, then ASSERT().
@@ -260,12 +264,13 @@ GetNextNode (
   zero nodes, this function returns TRUE. Otherwise, it returns FALSE.
 
   If ListHead is NULL, then ASSERT().
-  If ListHead was not initialized with InitializeListHead(), then ASSERT().
+  If ListHead was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or 
+  InitializeListHead(), then ASSERT().
   If PcdMaximumLinkedListLenth is not zero, and the number of nodes
   in List, including the List node, is greater than or equal to
   PcdMaximumLinkedListLength, then ASSERT().
 
-  @param  List  A pointer to the head node of a doubly linked list.
+  @param  ListHead  A pointer to the head node of a doubly linked list.
 
   @retval TRUE  The linked list is empty.
   @retval FALSE The linked list is not empty.
@@ -292,11 +297,12 @@ IsListEmpty (
 
   Returns TRUE if Node is equal to List.  Returns FALSE if Node is one of the
   nodes in the doubly linked list specified by List.  List must have been
-  initialized with InitializeListHead().
+  initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
 
   If List is NULL, then ASSERT().
   If Node is NULL, then ASSERT().
-  If List was not initialized with InitializeListHead(), then ASSERT().
+  If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(), 
+  then ASSERT().
   If PcdMaximumLinkedListLenth is not zero, and the number of nodes
   in List, including the List node, is greater than or equal to
   PcdMaximumLinkedListLength, then ASSERT().
@@ -329,11 +335,12 @@ IsNull (
 
   Returns TRUE if Node is the last node in the doubly linked list specified by
   List. Otherwise, FALSE is returned. List must have been initialized with
-  InitializeListHead().
+  INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead().
 
   If List is NULL, then ASSERT().
   If Node is NULL, then ASSERT().
-  If List was not initialized with InitializeListHead(), then ASSERT().
+  If List was not initialized with INTIALIZE_LIST_HEAD_VARIABLE() or
+  InitializeListHead(), then ASSERT().
   If PcdMaximumLinkedListLenth is not zero, and the number of nodes
   in List, including the List node, is greater than or equal to
   PcdMaximumLinkedListLength, then ASSERT().
@@ -369,8 +376,8 @@ IsNodeAtEnd (
   Otherwise, the location of the FirstEntry node is swapped with the location
   of the SecondEntry node in a doubly linked list. SecondEntry must be in the
   same double linked list as FirstEntry and that double linked list must have
-  been initialized with InitializeListHead(). SecondEntry is returned after the
+  been initialized with INTIALIZE_LIST_HEAD_VARIABLE() or InitializeListHead(). 
-  nodes are swapped.
+  SecondEntry is returned after the nodes are swapped.
 
   If FirstEntry is NULL, then ASSERT().
   If SecondEntry is NULL, then ASSERT().
@@ -383,7 +390,7 @@ IsNodeAtEnd (
   @param  FirstEntry  A pointer to a node in a linked list.
   @param  SecondEntry A pointer to another node in the same linked list.
 
-  @return SecondEntry after the nodes are swapped
+  @return SecondEntry.
 
 **/
 LIST_ENTRY *
@@ -449,11 +456,9 @@ SwapListEntries (
   linked list containing Entry, including the Entry node, is greater than
   or equal to PcdMaximumLinkedListLength, then ASSERT().
 
-  @param  Entry A pointer to a node in a linked list
+  @param  Entry A pointer to a node in a linked list.
 
-  @return The node following Entry in the doubly linked list.
+  @return Entry.
-          If Entry is the only node in the linked list, then
-          the head node of the linked list is returned.
 
 **/
 LIST_ENTRY *

MdePkg/Library/BaseLib/LongJump.c

@@ -20,16 +20,17 @@
 /**
   Restores the CPU context that was saved with SetJump().
 
-  Restores the CPU context from the buffer specified by JumpBuffer.
+  Restores the CPU context from the buffer specified by JumpBuffer. This
-  This function never returns to the caller.
+  function never returns to the caller. Instead is resumes execution based on
-  Instead is resumes execution based on the state of JumpBuffer.
+  the state of JumpBuffer.
 
   If JumpBuffer is NULL, then ASSERT().
   For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
   If Value is 0, then ASSERT().
 
   @param  JumpBuffer  A pointer to CPU context buffer.
-  @param  Value         The value to return when the SetJump() context is restored.
+  @param  Value       The value to return when the SetJump() context is
+                      restored and must be non-zero.
 
 **/
 VOID

MdePkg/Library/BaseLib/LowBitSet32.c

@@ -26,7 +26,7 @@
 
   @param  Operand The 32-bit operand to evaluate.
 
-  @return Position of the lowest bit set in Operand if found.
+  @retval 0..31  The lowest bit set in Operand was found.
   @retval -1    Operand is zero.
 
 **/

MdePkg/Library/BaseLib/LowBitSet64.c

@@ -26,9 +26,10 @@
 
   @param  Operand The 64-bit operand to evaluate.
 
-  @return Position of the lowest bit set in Operand if found.
+  @retval 0..63  The lowest bit set in Operand was found.
   @retval -1    Operand is zero.
 
+
 **/
 INTN
 EFIAPI

MdePkg/Library/BaseLib/MultU64x32.c

@@ -25,6 +25,8 @@
   unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
   bit unsigned result is returned.
 
+  If the result overflows, then ASSERT().
+
   @param  Multiplicand  A 64-bit unsigned value.
   @param  Multiplier    A 32-bit unsigned value.
 

MdePkg/Library/BaseLib/MultU64x64.c

@@ -25,6 +25,8 @@
   unsigned value Multiplier and generates a 64-bit unsigned result. This 64-
   bit unsigned result is returned.
 
+  If the result overflows, then ASSERT().
+
   @param  Multiplicand  A 64-bit unsigned value.
   @param  Multiplier    A 64-bit unsigned value.
 

MdePkg/Library/BaseLib/RRotU64.c

@@ -27,7 +27,7 @@
   @param  Operand The 64-bit operand to rotate right.
   @param  Count   The number of bits to rotate right.
 
-  @return Operand >>> Count
+  @return Operand >> Count
 
 **/
 UINT64

MdePkg/Library/BaseLib/String.c

@@ -46,7 +46,7 @@
   @param  Destination Pointer to a Null-terminated Unicode string.
   @param  Source      Pointer to a Null-terminated Unicode string.
 
-  @return Destination pointing to the copied string.
+  @return Destination.
 
 **/
 CHAR16 *
@@ -79,9 +79,8 @@ StrCpy (
 }
 
 /**
-  Copies one Null-terminated Unicode string with a maximum length to another
+  Copies up to a specified length from one Null-terminated Unicode string  to 
-  Null-terminated Unicode string with a maximum length and returns the new
+  another Null-terminated Unicode string and returns the new Unicode string.
-  Unicode string.
 
   This function copies the contents of the Unicode string Source to the Unicode
   string Destination, and returns Destination. At most, Length Unicode
@@ -104,7 +103,7 @@ StrCpy (
   @param  Source      Pointer to a Null-terminated Unicode string.
   @param  Length      Maximum number of Unicode characters to copy.
 
-  @return Destination pointing to the copied string.
+  @return Destination.
 
 **/
 CHAR16 *
@@ -188,8 +187,8 @@ StrLen (
   Returns the size of a Null-terminated Unicode string in bytes, including the
   Null terminator.
 
-  This function returns the size, in bytes, of the Null-terminated Unicode
+  This function returns the size, in bytes, of the Null-terminated Unicode string 
-  string specified by String.
+  specified by String.
 
   If String is NULL, then ASSERT().
   If String is not aligned on a 16-bit boundary, then ASSERT().
@@ -199,7 +198,7 @@ StrLen (
 
   @param  String  Pointer to a Null-terminated Unicode string.
 
-  @return The size in bytes of String.
+  @return The size of String.
 
 **/
 UINTN
@@ -236,8 +235,7 @@ StrSize (
   @param  SecondString  Pointer to a Null-terminated Unicode string.
 
   @retval 0      FirstString is identical to SecondString.
-  @return The first mismatched Unicode character in SecondString subtracted
+  @return others FirstString is not identical to SecondString.
-          from the first mismatched Unicode character in FirstString.
 
 **/
 INTN
@@ -261,8 +259,8 @@ StrCmp (
 }
 
 /**
-  Compares two Null-terminated Unicode strings with maximum lengths, and
+  Compares up to a specified length the contents of two Null-terminated Unicode strings,
-  returns the difference between the first mismatched Unicode characters.
+  and returns the difference between the first mismatched Unicode characters.
 
   This function compares the Null-terminated Unicode string FirstString to the
   Null-terminated Unicode string SecondString. At most, Length Unicode
@@ -287,8 +285,7 @@ StrCmp (
   @param  Length        Maximum number of Unicode characters to compare.
 
   @retval 0      FirstString is identical to SecondString.
-  @return The value returned is the first mismatched Unicode character in SecondString
+  @return others FirstString is not identical to SecondString.
-          subtracted from the first mismatched Unicode character in FirstString.
 
 **/
 INTN
@@ -332,7 +329,9 @@ StrnCmp (
   results are undefined.
 
   If Destination is NULL, then ASSERT().
+  If Destination is not aligned on a 16-bit bounadary, then ASSERT().
   If Source is NULL, then ASSERT().
+  If Source is not aligned on a 16-bit bounadary, then ASSERT().
   If Source and Destination overlap, then ASSERT().
   If PcdMaximumUnicodeStringLength is not zero, and Destination contains more
   than PcdMaximumUnicodeStringLength Unicode characters not including the
@@ -348,7 +347,7 @@ StrnCmp (
   @param  Destination Pointer to a Null-terminated Unicode string.
   @param  Source      Pointer to a Null-terminated Unicode string.
 
-  @return Destination pointing to the concatenated Unicode string.
+  @return Destination.
 
 **/
 CHAR16 *
@@ -369,8 +368,8 @@ StrCat (
 }
 
 /**
-  Concatenates one Null-terminated Unicode string with a maximum length to the
+  Concatenates up to a specified length one Null-terminated Unicode to the end 
-  end of another Null-terminated Unicode string, and returns the concatenated
+  of another Null-terminated Unicode string, and returns the concatenated 
   Unicode string.
 
   This function concatenates two Null-terminated Unicode strings. The contents
@@ -402,7 +401,7 @@ StrCat (
   @param  Length      Maximum number of Unicode characters to concatenate from
                       Source.
 
-  @return Destination pointing to the concatenated Unicode string.
+  @return Destination.
 
 **/
 CHAR16 *
@@ -424,7 +423,7 @@ StrnCat (
 }
 
 /**
-  Returns the first occurance of a Null-terminated Unicode sub-string 
+  Returns the first occurrence of a Null-terminated Unicode sub-string
   in a Null-terminated Unicode string.
 
   This function scans the contents of the Null-terminated Unicode string
@@ -446,7 +445,7 @@ StrnCat (
   @param  SearchString    Pointer to a Null-terminated Unicode string to search for.
 
   @retval NULL            If the SearchString does not appear in String.
-  @return Pointer to the matching sub-string.
+  @return others          If there is a match.
 
 **/
 CHAR16 *
@@ -627,7 +626,7 @@ InternalIsHexaDecimalDigitCharacter (
 
   @param  String      Pointer to a Null-terminated Unicode string.
 
-  @return The value of type UINTN converted.
+  @retval Value translated from String.
 
 **/
 UINTN
@@ -709,7 +708,7 @@ StrDecimalToUintn (
 
   @param  String          Pointer to a Null-terminated Unicode string.
 
-  @return The value of type UINT64 converted.
+  @retval Value translated from String.
 
 **/
 UINT64
@@ -791,7 +790,7 @@ StrDecimalToUint64 (
 
   @param  String          Pointer to a Null-terminated Unicode string.
 
-  @return The value of type UINTN converted.
+  @retval Value translated from String.
 
 **/
 UINTN
@@ -885,9 +884,9 @@ StrHexToUintn (
 
   @param  String          Pointer to a Null-terminated Unicode string.
 
-  @return The value of type UINT64 converted.
+  @retval Value translated from String.
 
-**/
+  **/
 UINT64
 EFIAPI
 StrHexToUint64 (
@@ -1001,19 +1000,16 @@ InternalAsciiIsHexaDecimalDigitCharacter (
 
   This function converts the content of the Unicode string Source
   to the ASCII string Destination by copying the lower 8 bits of
-  each Unicode character. It returns Destination. The function terminates 
+  each Unicode character. It returns Destination.
-  the ASCII string Destination  by appending a Null-terminator character 
+
-  at the end. The caller is responsible to make sure Destination points 
+  If any Unicode characters in Source contain non-zero value in
-  to a buffer with size equal or greater than (StrLen (Source) + 1) in bytes.
+  the upper 8 bits, then ASSERT().
 
   If Destination is NULL, then ASSERT().
   If Source is NULL, then ASSERT().
   If Source is not aligned on a 16-bit boundary, then ASSERT().
   If Source and Destination overlap, then ASSERT().
 
-  If any Unicode characters in Source contain non-zero value in 
-  the upper 8 bits, then ASSERT().
-  
   If PcdMaximumUnicodeStringLength is not zero, and Source contains
   more than PcdMaximumUnicodeStringLength Unicode characters not including
   the Null-terminator, then ASSERT().
@@ -1025,7 +1021,7 @@ InternalAsciiIsHexaDecimalDigitCharacter (
   @param  Source        Pointer to a Null-terminated Unicode string.
   @param  Destination   Pointer to a Null-terminated ASCII string.
 
-  @return Destination pointing to the converted ASCII string.
+  @return Destination.
 
 **/
 CHAR8 *
@@ -1092,7 +1088,7 @@ UnicodeStrToAsciiStr (
   @param  Destination Pointer to a Null-terminated ASCII string.
   @param  Source      Pointer to a Null-terminated ASCII string.
 
-  @return Destination pointing to the copied string.
+  @return Destination
 
 **/
 CHAR8 *
@@ -1124,9 +1120,8 @@ AsciiStrCpy (
 }
 
 /**
-  Copies one Null-terminated ASCII string with a maximum length to another
+  Copies up to a specified length one Null-terminated ASCII string to another 
-  Null-terminated ASCII string with a maximum length and returns the new ASCII
+  Null-terminated ASCII string and returns the new ASCII string.
-  string.
 
   This function copies the contents of the ASCII string Source to the ASCII
   string Destination, and returns Destination. At most, Length ASCII characters
@@ -1146,7 +1141,7 @@ AsciiStrCpy (
   @param  Source      Pointer to a Null-terminated ASCII string.
   @param  Length      Maximum number of ASCII characters to copy.
 
-  @return Destination pointing to the copied string.
+  @return Destination
 
 **/
 CHAR8 *
@@ -1191,7 +1186,8 @@ AsciiStrnCpy (
   This function returns the number of ASCII characters in the Null-terminated
   ASCII string specified by String.
 
-  If String is NULL, then ASSERT().
+  If Length > 0 and Destination is NULL, then ASSERT().
+  If Length > 0 and Source is NULL, then ASSERT().
   If PcdMaximumAsciiStringLength is not zero and String contains more than
   PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
   then ASSERT().
@@ -1271,9 +1267,8 @@ AsciiStrSize (
   @param  FirstString   Pointer to a Null-terminated ASCII string.
   @param  SecondString  Pointer to a Null-terminated ASCII string.
 
-  @retval 0      FirstString is identical to SecondString.
+  @retval ==0      FirstString is identical to SecondString.
-  @return The first mismatched ASCII character in SecondString subtracted
+  @retval !=0      FirstString is not identical to SecondString.
-          from the first mismatched ASCII character in FirstString.
 
 **/
 INTN
@@ -1369,10 +1364,10 @@ InternalAsciiHexCharToUintn (
   @param  FirstString   Pointer to a Null-terminated ASCII string.
   @param  SecondString  Pointer to a Null-terminated ASCII string.
 
-  @retval 0      FirstString is identical to SecondString using case insensitive
+  @retval ==0    FirstString is identical to SecondString using case insensitive
                  comparisons.
-  @return The first mismatched lower case ASCII character in SecondString subtracted
+  @retval !=0    FirstString is not identical to SecondString using case
-          from the first mismatched lower case ASCII character in FirstString.
+                 insensitive comparisons.
 
 **/
 INTN
@@ -1414,8 +1409,8 @@ AsciiStriCmp (
   is the first mismatched ASCII character in SecondString subtracted from the
   first mismatched ASCII character in FirstString.
 
-  If FirstString is NULL, then ASSERT().
+  If Length > 0 and FirstString is NULL, then ASSERT().
-  If SecondString is NULL, then ASSERT().
+  If Length > 0 and SecondString is NULL, then ASSERT().
   If PcdMaximumAsciiStringLength is not zero and FirstString contains more than
   PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
   then ASSERT().
@@ -1425,11 +1420,10 @@ AsciiStriCmp (
 
   @param  FirstString   Pointer to a Null-terminated ASCII string.
   @param  SecondString  Pointer to a Null-terminated ASCII string.
-  @param  Length        Maximum number of ASCII characters to compare.
+  @param  Length        Maximum number of ASCII characters for compare.
 
-  @retval 0      FirstString is identical to SecondString.
+  @retval ==0       FirstString is identical to SecondString.
-  @return The first mismatched ASCII character in SecondString subtracted from the
+  @retval !=0       FirstString is not identical to SecondString.
-          first mismatched ASCII character in FirstString.
 
 **/
 INTN
@@ -1484,7 +1478,7 @@ AsciiStrnCmp (
   @param  Destination Pointer to a Null-terminated ASCII string.
   @param  Source      Pointer to a Null-terminated ASCII string.
 
-  @return Destination pointing to the concatenated ASCII string.
+  @return Destination
 
 **/
 CHAR8 *
@@ -1505,9 +1499,9 @@ AsciiStrCat (
 }
 
 /**
-  Concatenates one Null-terminated ASCII string with a maximum length to the
+  Concatenates up to a specified length one Null-terminated ASCII string to 
-  end of another Null-terminated ASCII string, and returns the concatenated
+  the end of another Null-terminated ASCII string, and returns the 
-  ASCII string.
+  concatenated ASCII string.
 
   This function concatenates two Null-terminated ASCII strings. The contents
   of Null-terminated ASCII string Source are concatenated to the end of Null-
@@ -1517,8 +1511,8 @@ AsciiStrCat (
   Destination is returned unmodified. If Source and Destination overlap, then
   the results are undefined.
 
-  If Destination is NULL, then ASSERT().
+  If Length > 0 and Destination is NULL, then ASSERT().
-  If Source is NULL, then ASSERT().
+  If Length > 0 and Source is NULL, then ASSERT().
   If Source and Destination overlap, then ASSERT().
   If PcdMaximumAsciiStringLength is not zero, and Destination contains more than
   PcdMaximumAsciiStringLength ASCII characters not including the Null-terminator,
@@ -1535,7 +1529,7 @@ AsciiStrCat (
   @param  Length      Maximum number of ASCII characters to concatenate from
                       Source.
 
-  @return Destination pointing to the concatenated ASCII string.
+  @return Destination
 
 **/
 CHAR8 *
@@ -1557,7 +1551,7 @@ AsciiStrnCat (
 }
 
 /**
-  Returns the first occurance of a Null-terminated ASCII sub-string 
+  Returns the first occurrence of a Null-terminated ASCII sub-string
   in a Null-terminated ASCII string.
 
   This function scans the contents of the ASCII string specified by String
@@ -1576,7 +1570,8 @@ AsciiStrnCat (
   @param  SearchString    Pointer to a Null-terminated ASCII string to search for.
 
   @retval NULL            If the SearchString does not appear in String.
-  @return Pointer to the matching sub-string.
+  @retval others          If there is a match return the first occurrence of SearchingString.
+                          If the length of SearchString is zero,return String.
 
 **/
 CHAR8 *
@@ -1651,7 +1646,7 @@ AsciiStrStr (
 
   @param  String          Pointer to a Null-terminated ASCII string.
 
-  @return The value of type UINTN converted.
+  @retval Value translated from String.
 
 **/
 UINTN
@@ -1728,7 +1723,7 @@ AsciiStrDecimalToUintn (
 
   @param  String          Pointer to a Null-terminated ASCII string.
 
-  @return The value of type UINT64 converted.
+  @retval Value translated from String.
 
 **/
 UINT64
@@ -1808,7 +1803,7 @@ AsciiStrDecimalToUint64 (
 
   @param  String          Pointer to a Null-terminated ASCII string.
 
-  @return The value of type UINTN converted.
+  @retval Value translated from String.
 
 **/
 UINTN
@@ -1900,7 +1895,7 @@ AsciiStrHexToUintn (
 
   @param  String          Pointer to a Null-terminated ASCII string.
 
-  @return The value of type UINT64 converted.
+  @retval Value translated from String.
 
 **/
 UINT64
@@ -1989,7 +1984,7 @@ AsciiStrHexToUint64 (
   @param  Source        Pointer to a Null-terminated ASCII string.
   @param  Destination   Pointer to a Null-terminated Unicode string.
 
-  @return Destination pointing to the converted Unicode string.
+  @return Destination.
 
 **/
 CHAR16 *
@@ -2042,7 +2037,7 @@ AsciiStrToUnicodeStr (
 
   @param  Value The 8-bit value to convert to BCD. Range 0..99.
 
-  @return The BCD value converted.
+  @return The BCD value.
 
 **/
 UINT8
@@ -2066,7 +2061,7 @@ DecimalToBcd8 (
 
   @param  Value The 8-bit BCD value to convert to an 8-bit value.
 
-  @return The 8-bit decimal value converted.
+  @return The 8-bit value is returned.
 
 **/
 UINT8
@@ -2092,7 +2087,7 @@ BcdToDecimal8 (
 
   @param Nibble     The nibble which is in the low 4 bits of the input byte.
 
-  @return   The Unicode hexadecimal character.
+  @retval  CHAR16   The Unicode hexadecimal character.
 
 **/
 CHAR16
@@ -2121,17 +2116,18 @@ NibbleToHexChar (
   the last character in the output string. The one next to first byte will be put into the
   character before the last character. This rules applies to the rest of the bytes. The Unicode
   character by the last byte will be put into the first character in the output string. For example,
-  the input buffer for a 64-bits unsigned integrer 0x12345678abcdef1234 will be converted to
+  the input buffer for a 64-bits unsigned integer 0x12345678abcdef1234 will be converted to
   a Unicode string equal to L"12345678abcdef1234".
 
-  @param String                 Pointer to the buffer allocated for the convertion.
+  @param String                        On input, String is pointed to the buffer allocated for the convertion.
-  @param StringLen              On input: Pointer to length in bytes of buffer to hold the Unicode string.
+  @param StringLen                     The Length of String buffer to hold the output String. The length must include the tailing '\0' character.
-                                On output:If return EFI_SUCCESS, pointer to length of Unicode string converted.
+                                       The StringLen required to convert a N bytes Buffer will be a least equal to or greater 
-                                          If return EFI_BUFFER_TOO_SMALL, pointer to length of string buffer desired.
+                                       than 2*N + 1.
   @param Buffer                        The pointer to a input buffer.
-  @param BufferSizeInBytes      Lenth in bytes of the input buffer.
+  @param BufferSizeInBytes             Length in bytes of the input buffer.
 
-  @retval EFI_SUCCESS           The convertion is successfull. All bytes in Buffer has been convert to the corresponding
+
+  @retval  EFI_SUCCESS                 The convertion is successful. All bytes in Buffer has been convert to the corresponding
                                        Unicode character and placed into the right place in String.
   @retval  EFI_BUFFER_TOO_SMALL        StringSizeInBytes is smaller than 2 * N + 1the number of bytes required to
                                        complete the convertion. 
@@ -2285,9 +2281,10 @@ HexStringToBuf (
   Unicode character is converted to a byte. For example, Unicode character
   L'A' will be converted to 0x0A. 
 
-  If Digit is NULL, then ASSERT().
+  If Digit is NULL, then ASSERT.
 
   @param  Digit       The output hexadecimal digit.
+
   @param  Char        The input Unicode character.
 
   @retval TRUE        Char is in the range of Hexadecimal number. Digit is updated

MdePkg/Library/BaseLib/SwapBytes16.c

@@ -24,9 +24,9 @@
   from little endian to big endian or vice versa. The byte swapped value is
   returned.
 
-  @param  Operand A 16-bit unsigned value.
+  @param  Value Operand A 16-bit unsigned value.
 
-  @return The byte swaped Operand.
+  @return The byte swapped Operand.
 
 **/
 UINT16

MdePkg/Library/BaseLib/SwapBytes32.c

@@ -24,9 +24,9 @@
   from little endian to big endian or vice versa. The byte swapped value is
   returned.
 
-  @param  Operand A 32-bit unsigned value.
+  @param  Value Operand A 32-bit unsigned value.
 
-  @return The byte swaped Operand.
+  @return The byte swapped Operand.
 
 **/
 UINT32

MdePkg/Library/BaseLib/SwapBytes64.c

@@ -24,9 +24,9 @@
   from little endian to big endian or vice versa. The byte swapped value is
   returned.
 
-  @param  Operand A 64-bit unsigned value.
+  @param  Value Operand A 64-bit unsigned value.
 
-  @return The byte swaped Operand.
+  @return The byte swapped Operand.
 
 **/
 UINT64

MdePkg/Library/BaseLib/Synchronization.c

@@ -55,7 +55,7 @@ GetSpinLockProperties (
   @param  SpinLock  A pointer to the spin lock to initialize to the released
                     state.
 
-  @return SpinLock initialized in release state.
+  @return SpinLock in release state.
 
 **/
 SPIN_LOCK *
@@ -86,7 +86,7 @@ InitializeSpinLock (
 
   @param  SpinLock  A pointer to the spin lock to place in the acquired state.
 
-  @return SpinLock aquired lock.
+  @return SpinLock acquired lock.
 
 **/
 SPIN_LOCK *
@@ -206,7 +206,7 @@ AcquireSpinLockOrFail (
 
   @param  SpinLock  A pointer to the spin lock to release.
 
-  @return SpinLock
+  @return SpinLock released lock.
 
 **/
 SPIN_LOCK *

MdePkg/Library/BaseLib/SynchronizationGcc.c

@@ -98,7 +98,7 @@ InitializeSpinLock (
 
   @param  SpinLock  A pointer to the spin lock to place in the acquired state.
 
-  @return SpinLock accquired lock.
+  @return SpinLock acquired lock.
 
 **/
 SPIN_LOCK *

MdePkg/Library/BaseLib/SynchronizationMsc.c

@@ -66,7 +66,7 @@ GetSpinLockProperties (
   @param  SpinLock  A pointer to the spin lock to initialize to the released
                     state.
 
-  @return SpinLock in released state.
+  @return SpinLock in release state.
 
 **/
 SPIN_LOCK *
@@ -101,7 +101,7 @@ InitializeSpinLock (
 
   @param  SpinLock  A pointer to the spin lock to place in the acquired state.
 
-  @return SpinLock aquiring lock.
+  @return SpinLock acquired lock.
 
 **/
 SPIN_LOCK *
@@ -224,7 +224,7 @@ AcquireSpinLockOrFail (
 
   @param  SpinLock  A pointer to the spin lock to release.
 
-  @return SpinLock releasing lock.
+  @return SpinLock released lock.
 
 **/
 SPIN_LOCK *

MdePkg/Library/BaseLib/X86GetInterruptState.c

@@ -19,8 +19,8 @@
 /**
   Retrieves the current CPU interrupt state.
 
-  Retrieves the current CPU interrupt state. Returns TRUE is interrupts are
+  Returns TRUE is interrupts are currently enabled. Otherwise
-  currently enabled. Otherwise returns FALSE.
+  returns FALSE.
 
   @retval TRUE  CPU interrupts are enabled.
   @retval FALSE CPU interrupts are disabled.