diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h index d7c96a1a62..ae14cc72ea 100644 --- a/MdePkg/Include/Library/BaseLib.h +++ b/MdePkg/Include/Library/BaseLib.h @@ -632,7 +632,7 @@ StrHexToUint64 ( @param Source Pointer to a Null-terminated Unicode string. @param Destination Pointer to a Null-terminated ASCII string. - @reture Destination + @return Destination **/ CHAR8 * @@ -1802,7 +1802,7 @@ GetPowerOfTwo64 ( 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. @@ -1821,7 +1821,7 @@ SwapBytes16 ( 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. @@ -1840,7 +1840,7 @@ SwapBytes32 ( 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. diff --git a/MdePkg/Include/Library/PcdLib.h b/MdePkg/Include/Library/PcdLib.h index 2b9c76796b..8db9a0270a 100644 --- a/MdePkg/Include/Library/PcdLib.h +++ b/MdePkg/Include/Library/PcdLib.h @@ -15,6 +15,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #ifndef __PCD_LIB_H__ #define __PCD_LIB_H__ +#include + #define PCD_INVALID_TOKEN_NUMBER ((UINTN) 0) #define PcdToken(TokenName) _PCD_TOKEN_##TokenName @@ -126,7 +128,7 @@ LibPcdSetSku ( /** Returns the 8-bit value for the token specified by TokenNumber. - @param[in] The PCD token number to retrieve a current value for. + @param[in] TokenNumber The PCD token number to retrieve a current value for. @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber. @@ -141,7 +143,7 @@ LibPcdGet8 ( /** Returns the 16-bit value for the token specified by TokenNumber. - @param[in] The PCD token number to retrieve a current value for. + @param[in] TokenNumber The PCD token number to retrieve a current value for. @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber. @@ -446,9 +448,9 @@ LibPcdSet64 ( If SizeOfValue is NULL, then ASSERT(). If SizeOfValue > 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. - @param[in] Value A pointer to the buffer to set. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in,out] SizeOfBuffer The size, in bytes, of Buffer. + @param[in] Buffer Value A pointer to the buffer to set. @retval VOID* Return the pointer for the buffer been set. @@ -634,10 +636,10 @@ LibPcdSetExBool ( modify the internal data in PCD database. - @param[in] CallBackGuid The PCD token GUID being set. - @param[in] CallBackToken The PCD token number being set. - @param[in, out] TokenData A pointer to the token data being set. - @param[in] TokenDataSize The size, in bytes, of the data being set. + @param[in] CallBackGuid The PCD token GUID being set. + @param[in] CallBackToken The PCD token number being set. + @param[in, out] TokenData A pointer to the token data being set. + @param[in] TokenDataSize The size, in bytes, of the data being set. @retval VOID @@ -704,10 +706,10 @@ LibPcdCancelCallback ( token number in the token space, then 0 is returned. If TokenNumber is not 0 and is not in the token space specified by Guid, then ASSERT(). - @param[in] 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. - @param[in] The previous PCD token number. If 0, then retrieves the first PCD - token number. + @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. + @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD + token number. @retval UINTN The next valid token number. diff --git a/MdePkg/Include/Library/ReportStatusCodeLib.h b/MdePkg/Include/Library/ReportStatusCodeLib.h index 2dfa8f839b..b07b4adaa9 100644 --- a/MdePkg/Include/Library/ReportStatusCodeLib.h +++ b/MdePkg/Include/Library/ReportStatusCodeLib.h @@ -15,6 +15,8 @@ #ifndef __REPORT_STATUS_CODE_LIB_H__ #define __REPORT_STATUS_CODE_LIB_H__ +#include +#include #include // diff --git a/MdePkg/Library/BaseLib/Ia32/Non-existing.c b/MdePkg/Library/BaseLib/Ia32/Non-existing.c index 3a835fb7ee..96e90de64d 100644 --- a/MdePkg/Library/BaseLib/Ia32/Non-existing.c +++ b/MdePkg/Library/BaseLib/Ia32/Non-existing.c @@ -31,9 +31,9 @@ specified by Context1 and Context2. Context1 and Context2 are optional and may be 0. The function EntryPoint must never return. - @param Cs The 16-bit selector to load in the CS before EntryPoint - is called. The descriptor in the GDT that this selector - references must be setup for 32-bit protected mode. + @param CodeSelector The 16-bit selector to load in the CS before EntryPoint + is called. The descriptor in the GDT that this selector + references must be setup for 32-bit protected mode. @param EntryPoint The 64-bit virtual address of the function to call with the new stack after paging is disabled. @param Context1 The 64-bit virtual address of the context to pass into diff --git a/MdePkg/Library/BaseLib/LinkedList.c b/MdePkg/Library/BaseLib/LinkedList.c index 8190ca345c..5d804109ab 100644 --- a/MdePkg/Library/BaseLib/LinkedList.c +++ b/MdePkg/Library/BaseLib/LinkedList.c @@ -89,7 +89,7 @@ IsNodeInList ( If ListHead is NULL, then ASSERT(). - @param ListHead A pointer to the head node of a new doubly linked list. + @param List A pointer to the head node of a new doubly linked list. @return ListHead @@ -122,7 +122,7 @@ InitializeListHead ( of nodes in ListHead, including the ListHead node, is greater than or equal to PcdMaximumLinkedListLength, then ASSERT(). - @param ListHead A pointer to the head node of a doubly linked list. + @param List 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. @@ -162,7 +162,7 @@ InsertHeadList ( of nodes in ListHead, including the ListHead node, is greater than or equal to PcdMaximumLinkedListLength, then ASSERT(). - @param ListHead A pointer to the head node of a doubly linked list. + @param List 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. @@ -269,7 +269,7 @@ GetNextNode ( in List, including the List node, is greater than or equal to PcdMaximumLinkedListLength, then ASSERT(). - @param ListHead A pointer to the head node of a doubly linked list. + @param List 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. diff --git a/MdePkg/Library/BaseLib/String.c b/MdePkg/Library/BaseLib/String.c index 9fca968074..94471f3329 100644 --- a/MdePkg/Library/BaseLib/String.c +++ b/MdePkg/Library/BaseLib/String.c @@ -1019,7 +1019,7 @@ InternalAsciiIsHexaDecimalDigitCharacter ( @param Source Pointer to a Null-terminated Unicode string. @param Destination Pointer to a Null-terminated ASCII string. - @reture Destination + @return Destination **/ CHAR8 * @@ -1418,7 +1418,8 @@ 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. + @retval 0 FirstString is identical to SecondString. @retval !=0 FirstString is not identical to SecondString. @@ -1980,7 +1981,7 @@ AsciiStrHexToUint64 ( @param Source Pointer to a Null-terminated ASCII string. @param Destination Pointer to a Null-terminated Unicode string. - @reture Destination + @return Destination **/ CHAR16 * diff --git a/MdePkg/Library/BaseMemoryLibOptDxe/MemLibInternals.h b/MdePkg/Library/BaseMemoryLibOptDxe/MemLibInternals.h index ceddbbe7a0..258dd1013a 100644 --- a/MdePkg/Library/BaseMemoryLibOptDxe/MemLibInternals.h +++ b/MdePkg/Library/BaseMemoryLibOptDxe/MemLibInternals.h @@ -32,9 +32,9 @@ /** Copy Length bytes from Source to Destination. - @param Destination Target of copy - @param Source Place to copy from - @param Length Number of bytes to copy + @param DestinationBuffer Target of copy + @param SourceBuffer Place to copy from + @param Length Number of bytes to copy @return Destination @@ -50,9 +50,9 @@ InternalMemCopyMem ( /** Set Buffer to Value for Size bytes. - @param Buffer Memory to set. - @param Size Number of bytes to set - @param Value Value of the set operation. + @param Buffer Memory to set. + @param Length Number of bytes to set + @param Value Value of the set operation. @return Buffer @@ -123,7 +123,7 @@ InternalMemSetMem64 ( Set Buffer to 0 for Size bytes. @param Buffer Memory to set. - @param Size Number of bytes to set + @param Length Number of bytes to set @return Buffer diff --git a/MdePkg/Library/DxePcdLib/DxePcdLib.c b/MdePkg/Library/DxePcdLib/DxePcdLib.c index 98882d4166..10d6a20381 100644 --- a/MdePkg/Library/DxePcdLib/DxePcdLib.c +++ b/MdePkg/Library/DxePcdLib/DxePcdLib.c @@ -89,7 +89,7 @@ LibPcdSetSku ( /** Returns the 8-bit value for the token specified by TokenNumber. - @param[in] The PCD token number to retrieve a current value for. + @param[in] TokenNumber The PCD token number to retrieve a current value for. @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber. @@ -108,7 +108,7 @@ LibPcdGet8 ( /** Returns the 16-bit value for the token specified by TokenNumber. - @param[in] The PCD token number to retrieve a current value for. + @param[in] TokenNumber The PCD token number to retrieve a current value for. @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber. @@ -517,9 +517,9 @@ LibPcdSet64 ( If SizeOfValue > 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. - @param[in] Value A pointer to the buffer to set. + @param[in] TokenNumber The PCD token number to set a current value for. + @param[in,out] SizeOfBuffer The size, in bytes, of Buffer. + @param[in] Buffer A pointer to the buffer to set. @retval VOID* Return the pointer for the buffer been set. @@ -557,7 +557,7 @@ LibPcdSetPtr ( to the value specified by Value. Value is returned. @param[in] TokenNumber The PCD token number to set a current value for. - @param[in] Value The boolean value to set. + @param[in] Value The boolean value to set. @retval BOOLEAN Return the value been set. @@ -875,10 +875,10 @@ LibPcdCancelCallback ( token number in the token space, then 0 is returned. If TokenNumber is not 0 and is not in the token space specified by Guid, then ASSERT(). - @param[in] 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. - @param[in] The previous PCD token number. If 0, then retrieves the first PCD - token number. + @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. + @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD + token number. @retval UINTN The next valid token number. @@ -912,8 +912,8 @@ LibPcdGetNextToken ( - @param[in] Pointer to a 128-bit unique value that designates from which namespace - to start the search. + @param[in] Guid Pointer to a 128-bit unique value that designates from which namespace + to start the search. @retval CONST GUID * The next valid token namespace.