diff options
author | eric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-09-16 06:01:21 +0000 |
---|---|---|
committer | eric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-09-16 06:01:21 +0000 |
commit | f73e0ad215de60ef1f3b1fac6b5c880da38edef0 (patch) | |
tree | 2f5cfbfd687e4f1bd945e2bb947ad68a0c472566 | |
parent | 55f298c3a371fc7c04fda5d120a601cda68c140d (diff) | |
download | edk2-platforms-f73e0ad215de60ef1f3b1fac6b5c880da38edef0.tar.xz |
follow up code review
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5893 6f19259b-4bc3-4df7-8a09-765794883524
-rw-r--r-- | MdePkg/Include/Library/PcdLib.h | 62 | ||||
-rw-r--r-- | MdePkg/Library/BasePcdLibNull/PcdLib.c | 59 | ||||
-rw-r--r-- | MdePkg/Library/DxePcdLib/DxePcdLib.c | 60 | ||||
-rw-r--r-- | MdePkg/Library/PeiPcdLib/PeiPcdLib.c | 60 |
4 files changed, 123 insertions, 118 deletions
diff --git a/MdePkg/Include/Library/PcdLib.h b/MdePkg/Include/Library/PcdLib.h index a856b3fbe1..6298ce8a05 100644 --- a/MdePkg/Include/Library/PcdLib.h +++ b/MdePkg/Include/Library/PcdLib.h @@ -23,8 +23,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #ifndef __PCD_LIB_H__
#define __PCD_LIB_H__
-#include <Base.h>
-
#define PCD_INVALID_TOKEN_NUMBER ((UINTN) 0)
#define PCD_MAX_SKU_ID 0x100
@@ -124,7 +122,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and
set values associated with a PCD token.
- @retval SKU_ID Return the SKU ID that just be set.
+ @return Return the SKU ID that just be set.
**/
UINTN
@@ -139,7 +137,7 @@ LibPcdSetSku ( @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.
+ @return Returns the 8-bit value for the token specified by TokenNumber.
**/
UINT8
@@ -154,7 +152,7 @@ LibPcdGet8 ( @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.
+ @return Returns the 16-bit value for the token specified by TokenNumber.
**/
UINT16
@@ -169,7 +167,7 @@ LibPcdGet16 ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT32 Returns the 32-bit value for the token specified by TokenNumber.
+ @return Returns the 32-bit value for the token specified by TokenNumber.
**/
UINT32
@@ -184,7 +182,7 @@ LibPcdGet32 ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT64 Returns the 64-bit value for the token specified by TokenNumber.
+ @return Returns the 64-bit value for the token specified by TokenNumber.
**/
UINT64
@@ -199,7 +197,7 @@ LibPcdGet64 ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval VOID* Returns the pointer to the token specified by TokenNumber.
+ @return Returns the pointer to the token specified by TokenNumber.
**/
VOID *
@@ -214,7 +212,7 @@ LibPcdGetPtr ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval BOOLEAN Returns the Boolean value of the token specified by TokenNumber.
+ @return Returns the Boolean value of the token specified by TokenNumber.
**/
BOOLEAN
@@ -229,7 +227,7 @@ LibPcdGetBool ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINTN Returns the size of the token specified by TokenNumber.
+ @return Returns the size of the token specified by TokenNumber.
**/
UINTN
@@ -247,7 +245,7 @@ LibPcdGetSize ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT8 Return the UINT8.
+ @return Return the UINT8.
**/
UINT8
@@ -266,7 +264,7 @@ LibPcdGetEx8 ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT16 Return the UINT16.
+ @return Return the UINT16.
**/
UINT16
@@ -285,7 +283,7 @@ LibPcdGetEx16 ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT32 Return the UINT32.
+ @return Return the UINT32.
**/
UINT32
@@ -304,7 +302,7 @@ LibPcdGetEx32 ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT64 Return the UINT64.
+ @return Return the UINT64.
**/
UINT64
@@ -323,7 +321,7 @@ LibPcdGetEx64 ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval VOID* Return the VOID* pointer.
+ @return Return the VOID* pointer.
**/
VOID *
@@ -342,7 +340,7 @@ LibPcdGetExPtr ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval BOOLEAN Return the BOOLEAN.
+ @return Return the BOOLEAN.
**/
BOOLEAN
@@ -361,7 +359,7 @@ LibPcdGetExBool ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINTN Return the size.
+ @return Return the size.
**/
UINTN
@@ -379,7 +377,7 @@ LibPcdGetExSize ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
- @retval UINT8 Return the value been set.
+ @return Return the value been set.
**/
UINT8
@@ -397,7 +395,7 @@ LibPcdSet8 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
- @retval UINT16 Return the value been set.
+ @return Return the value been set.
**/
UINT16
@@ -415,7 +413,7 @@ LibPcdSet16 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
- @retval UINT32 Return the value been set.
+ @return Return the value been set.
**/
UINT32
@@ -433,7 +431,7 @@ LibPcdSet32 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
- @retval UINT64 Return the value been set.
+ @return Return the value been set.
**/
UINT64
@@ -461,7 +459,7 @@ LibPcdSet64 ( @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.
+ @return Return the pointer for the buffer been set.
**/
VOID*
@@ -480,7 +478,7 @@ LibPcdSetPtr ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The boolean value to set.
- @retval BOOLEAN Return the value been set.
+ @return Return the value been set.
**/
BOOLEAN
@@ -501,7 +499,7 @@ LibPcdSetBool ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
- @retval UINT8 Return the value been set.
+ @return Return the value been set.
**/
UINT8
@@ -523,7 +521,7 @@ LibPcdSetEx8 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
- @retval UINT8 Return the value been set.
+ @return Return the value been set.
**/
UINT16
@@ -545,7 +543,7 @@ LibPcdSetEx16 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
- @retval UINT32 Return the value been set.
+ @return Return the value been set.
**/
UINT32
@@ -567,7 +565,7 @@ LibPcdSetEx32 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
- @retval UINT64 Return the value been set.
+ @return Return the value been set.
**/
UINT64
@@ -596,7 +594,7 @@ LibPcdSetEx64 ( @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
@param[in] Buffer A pointer to the buffer to set.
- @retval VOID * Return the pinter to the buffer been set.
+ @return Return the pinter to the buffer been set.
**/
VOID *
@@ -619,7 +617,7 @@ LibPcdSetExPtr ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The Boolean value to set.
- @retval Boolean Return the value been set.
+ @return Return the value been set.
**/
BOOLEAN
@@ -714,7 +712,7 @@ LibPcdCancelCallback ( @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD
token number.
- @retval UINTN The next valid token number.
+ @return The next valid token number.
**/
UINTN
@@ -740,7 +738,7 @@ LibPcdGetNextToken ( @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.
+ @return The next valid token namespace.
**/
GUID *
@@ -767,6 +765,8 @@ LibPcdGetNextTokenSpace ( @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.
@param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.
@param[in] Buffer A pointer to the buffer to used to set the target variable.
+
+ @return Return the pinter to the buffer been set.
**/
VOID *
diff --git a/MdePkg/Library/BasePcdLibNull/PcdLib.c b/MdePkg/Library/BasePcdLibNull/PcdLib.c index 77fb1e5c38..926d82ff3f 100644 --- a/MdePkg/Library/BasePcdLibNull/PcdLib.c +++ b/MdePkg/Library/BasePcdLibNull/PcdLib.c @@ -25,7 +25,7 @@ @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and
set values associated with a PCD token.
- @retval SKU_ID Return the SKU ID that just be set.
+ @return Return the SKU ID that just be set.
**/
UINTN
@@ -44,7 +44,7 @@ LibPcdSetSku ( @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.
+ @return Returns the 8-bit value for the token specified by TokenNumber.
**/
UINT8
@@ -65,7 +65,7 @@ LibPcdGet8 ( @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.
+ @return Returns the 16-bit value for the token specified by TokenNumber.
**/
UINT16
@@ -86,7 +86,7 @@ LibPcdGet16 ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT32 Returns the 32-bit value for the token specified by TokenNumber.
+ @return Returns the 32-bit value for the token specified by TokenNumber.
**/
UINT32
@@ -107,7 +107,7 @@ LibPcdGet32 ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT64 Returns the 64-bit value for the token specified by TokenNumber.
+ @return Returns the 64-bit value for the token specified by TokenNumber.
**/
UINT64
@@ -128,7 +128,7 @@ LibPcdGet64 ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval VOID* Returns the pointer to the token specified by TokenNumber.
+ @return Returns the pointer to the token specified by TokenNumber.
**/
VOID *
@@ -149,7 +149,7 @@ LibPcdGetPtr ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval BOOLEAN Returns the Boolean value of the token specified by TokenNumber.
+ @return Returns the Boolean value of the token specified by TokenNumber.
**/
BOOLEAN
@@ -170,7 +170,7 @@ LibPcdGetBool ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINTN Returns the size of the token specified by TokenNumber.
+ @return Returns the size of the token specified by TokenNumber.
**/
UINTN
@@ -194,7 +194,7 @@ LibPcdGetSize ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT8 Return the UINT8.
+ @return Return the UINT8.
**/
UINT8
@@ -219,7 +219,7 @@ LibPcdGetEx8 ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT16 Return the UINT16.
+ @return Return the UINT16.
**/
UINT16
@@ -244,7 +244,7 @@ LibPcdGetEx16 ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT32 Return the UINT32.
+ @return Return the UINT32.
**/
UINT32
@@ -269,7 +269,7 @@ LibPcdGetEx32 ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT64 Return the UINT64.
+ @return Return the UINT64.
**/
UINT64
@@ -294,7 +294,7 @@ LibPcdGetEx64 ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval VOID* Return the VOID* pointer.
+ @return Return the VOID* pointer.
**/
VOID *
@@ -319,7 +319,7 @@ LibPcdGetExPtr ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval BOOLEAN Return the BOOLEAN.
+ @return Return the BOOLEAN.
**/
BOOLEAN
@@ -344,7 +344,7 @@ LibPcdGetExBool ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINTN Return the size.
+ @return Return the size.
**/
UINTN
@@ -368,7 +368,7 @@ LibPcdGetExSize ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
- @retval UINT8 Return the value been set.
+ @return Return the value been set.
**/
UINT8
@@ -392,7 +392,7 @@ LibPcdSet8 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
- @retval UINT16 Return the value been set.
+ @return Return the value been set.
**/
UINT16
@@ -416,7 +416,7 @@ LibPcdSet16 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
- @retval UINT32 Return the value been set.
+ @return Return the value been set.
**/
UINT32
@@ -440,7 +440,7 @@ LibPcdSet32 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
- @retval UINT64 Return the value been set.
+ @return Return the value been set.
**/
UINT64
@@ -475,7 +475,7 @@ LibPcdSet64 ( @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.
+ @return Return the pointer for the buffer been set.
**/
VOID *
@@ -500,7 +500,7 @@ LibPcdSetPtr ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The boolean value to set.
- @retval BOOLEAN Return the value been set.
+ @return Return the value been set.
**/
BOOLEAN
@@ -527,7 +527,7 @@ LibPcdSetBool ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
- @retval UINT8 Return the value been set.
+ @return Return the value been set.
**/
UINT8
@@ -555,7 +555,7 @@ LibPcdSetEx8 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
- @retval UINT8 Return the value been set.
+ @return Return the value been set.
**/
UINT16
@@ -583,7 +583,7 @@ LibPcdSetEx16 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
- @retval UINT32 Return the value been set.
+ @return Return the value been set.
**/
UINT32
@@ -611,7 +611,7 @@ LibPcdSetEx32 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
- @retval UINT64 Return the value been set.
+ @return Return the value been set.
**/
UINT64
@@ -644,7 +644,7 @@ LibPcdSetEx64 ( @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
@param[in] Buffer A pointer to the buffer to set.
- @retval VOID * Return the pinter to the buffer been set.
+ @return Return the pinter to the buffer been set.
**/
VOID *
@@ -673,7 +673,7 @@ LibPcdSetExPtr ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The Boolean value to set.
- @retval Boolean Return the value been set.
+ @return Return the value been set.
**/
BOOLEAN
@@ -757,7 +757,7 @@ LibPcdCancelCallback ( @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD
token number.
- @retval UINTN The next valid token number.
+ @return The next valid token number.
**/
UINTN
@@ -788,7 +788,7 @@ LibPcdGetNextToken ( @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.
+ @return The next valid token namespace.
**/
GUID *
@@ -821,6 +821,7 @@ LibPcdGetNextTokenSpace ( @param[in] MaximumDatumSize The maximum size allowed for the PCD entry specified by PatchVariable.
@param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.
@param[in] Buffer A pointer to the buffer to used to set the target variable.
+ @return Return the pinter to the buffer been set.
**/
VOID *
diff --git a/MdePkg/Library/DxePcdLib/DxePcdLib.c b/MdePkg/Library/DxePcdLib/DxePcdLib.c index e780bd32a2..b76730f425 100644 --- a/MdePkg/Library/DxePcdLib/DxePcdLib.c +++ b/MdePkg/Library/DxePcdLib/DxePcdLib.c @@ -63,7 +63,7 @@ PcdLibConstructor ( @param[in] SkuId System SKU ID. The SKU value that will be used when the PCD service will retrieve and
set values.
- @retval SKU_ID Return the SKU ID that just be set.
+ @return Return the SKU ID that just be set.
**/
UINTN
@@ -86,7 +86,7 @@ LibPcdSetSku ( @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.
+ @return Returns the 8-bit value for the token specified by TokenNumber.
**/
UINT8
@@ -105,7 +105,7 @@ LibPcdGet8 ( @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.
+ @return Returns the 16-bit value for the token specified by TokenNumber.
**/
UINT16
@@ -124,7 +124,7 @@ LibPcdGet16 ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT32 Returns the 32-bit value for the token specified by TokenNumber.
+ @return Returns the 32-bit value for the token specified by TokenNumber.
**/
UINT32
@@ -143,7 +143,7 @@ LibPcdGet32 ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT64 Returns the 64-bit value for the token specified by TokenNumber.
+ @return Returns the 64-bit value for the token specified by TokenNumber.
**/
UINT64
@@ -162,7 +162,7 @@ LibPcdGet64 ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval VOID* Returns the pointer to the token specified by TokenNumber.
+ @return Returns the pointer to the token specified by TokenNumber.
**/
VOID *
@@ -181,7 +181,7 @@ LibPcdGetPtr ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval BOOLEAN Returns the Boolean value of the token specified by TokenNumber.
+ @return Returns the Boolean value of the token specified by TokenNumber.
**/
BOOLEAN
@@ -200,7 +200,7 @@ LibPcdGetBool ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINTN Returns the size of the token specified by TokenNumber.
+ @return Returns the size of the token specified by TokenNumber.
**/
UINTN
@@ -222,7 +222,7 @@ LibPcdGetSize ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT8 Return the UINT8.
+ @return Return the UINT8.
**/
UINT8
@@ -246,7 +246,7 @@ LibPcdGetEx8 ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT16 Return the UINT16.
+ @return Return the UINT16.
**/
UINT16
@@ -270,7 +270,7 @@ LibPcdGetEx16 ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT32 Return the UINT32.
+ @return Return the UINT32.
**/
UINT32
@@ -295,7 +295,7 @@ LibPcdGetEx32 ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT64 Return the UINT64.
+ @return Return the UINT64.
**/
UINT64
@@ -320,7 +320,7 @@ LibPcdGetEx64 ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval VOID* Return the VOID* pointer.
+ @return Return the VOID* pointer.
**/
VOID *
@@ -345,7 +345,7 @@ LibPcdGetExPtr ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval BOOLEAN Return the BOOLEAN.
+ @return Return the BOOLEAN.
**/
BOOLEAN
@@ -370,7 +370,7 @@ LibPcdGetExBool ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINTN Return the size.
+ @return Return the size.
**/
UINTN
@@ -395,7 +395,7 @@ LibPcdGetExSize ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
- @retval UINT8 Return the value been set.
+ @return Return the value been set.
**/
UINT8
@@ -424,7 +424,7 @@ LibPcdSet8 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
- @retval UINT16 Return the value been set.
+ @return Return the value been set.
**/
UINT16
@@ -453,7 +453,7 @@ LibPcdSet16 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
- @retval UINT32 Return the value been set.
+ @return Return the value been set.
**/
UINT32
@@ -481,7 +481,7 @@ LibPcdSet32 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
- @retval UINT64 Return the value been set.
+ @return Return the value been set.
**/
UINT64
@@ -521,7 +521,7 @@ LibPcdSet64 ( In out, returns actual size of buff is set.
@param[in] Buffer A pointer to the buffer to set.
- @retval VOID* Return the pointer for the buffer been set.
+ @return Return the pointer for the buffer been set.
**/
VOID *
@@ -559,7 +559,7 @@ LibPcdSetPtr ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The boolean value to set.
- @retval BOOLEAN Return the value been set.
+ @return Return the value been set.
**/
BOOLEAN
@@ -591,7 +591,7 @@ LibPcdSetBool ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
- @retval UINT8 Return the value been set.
+ @return Return the value been set.
**/
UINT8
@@ -626,7 +626,7 @@ LibPcdSetEx8 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
- @retval UINT16 Return the value been set.
+ @return Return the value been set.
**/
UINT16
@@ -661,7 +661,7 @@ LibPcdSetEx16 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
- @retval UINT32 Return the value been set.
+ @return Return the value been set.
**/
UINT32
@@ -695,7 +695,7 @@ LibPcdSetEx32 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
- @retval UINT64 Return the value been set.
+ @return Return the value been set.
**/
UINT64
@@ -735,7 +735,7 @@ LibPcdSetEx64 ( In out, returns actual size of buffer is set.
@param[in] Buffer A pointer to the buffer to set.
- @retval VOID * Return the pinter to the buffer been set.
+ @return Return the pinter to the buffer been set.
**/
VOID *
@@ -779,7 +779,7 @@ LibPcdSetExPtr ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The Boolean value to set.
- @retval Boolean Return the value been set.
+ @return Return the value been set.
**/
BOOLEAN
@@ -888,7 +888,7 @@ LibPcdCancelCallback ( @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD
token number.
- @retval UINTN The next valid token number.
+ @return The next valid token number.
**/
UINTN
@@ -922,7 +922,7 @@ LibPcdGetNextToken ( @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.
+ @return The next valid token namespace.
**/
GUID *
@@ -960,6 +960,8 @@ LibPcdGetNextTokenSpace ( In out, returns actual size of buffer is set.
@param[in] Buffer A pointer to the buffer to used to set the target variable.
+ @return Return the pinter to the buffer been set.
+
**/
VOID *
EFIAPI
diff --git a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c index 03ef1d7f26..248512ed01 100644 --- a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c +++ b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c @@ -56,7 +56,7 @@ GetPcdPpiPointer ( @param[in] System sku id. The SKU value that will be used when the PCD service will retrieve and
set values.
- @retval SKU_ID Return the SKU ID that just be set.
+ @return Return the SKU ID that just be set.
**/
UINTN
@@ -80,7 +80,7 @@ LibPcdSetSku ( @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.
+ @return Returns the 8-bit value for the token specified by TokenNumber.
**/
UINT8
@@ -99,7 +99,7 @@ LibPcdGet8 ( @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.
+ @return Returns the 16-bit value for the token specified by TokenNumber.
**/
UINT16
@@ -118,7 +118,7 @@ LibPcdGet16 ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT32 Returns the 32-bit value for the token specified by TokenNumber.
+ @return Returns the 32-bit value for the token specified by TokenNumber.
**/
UINT32
@@ -137,7 +137,7 @@ LibPcdGet32 ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT64 Returns the 64-bit value for the token specified by TokenNumber.
+ @return Returns the 64-bit value for the token specified by TokenNumber.
**/
UINT64
@@ -156,7 +156,7 @@ LibPcdGet64 ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval VOID* Returns the pointer to the token specified by TokenNumber.
+ @return Returns the pointer to the token specified by TokenNumber.
**/
VOID *
@@ -175,7 +175,7 @@ LibPcdGetPtr ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval BOOLEAN Returns the Boolean value of the token specified by TokenNumber.
+ @return Returns the Boolean value of the token specified by TokenNumber.
**/
BOOLEAN
@@ -194,7 +194,7 @@ LibPcdGetBool ( @param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINTN Returns the size of the token specified by TokenNumber.
+ @return Returns the size of the token specified by TokenNumber.
**/
UINTN
@@ -216,7 +216,7 @@ LibPcdGetSize ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT8 Return the UINT8.
+ @return Return the UINT8.
**/
UINT8
@@ -241,7 +241,7 @@ LibPcdGetEx8 ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT16 Return the UINT16.
+ @return Return the UINT16.
**/
UINT16
@@ -267,7 +267,7 @@ LibPcdGetEx16 ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT32 Return the UINT32.
+ @return Return the UINT32.
**/
UINT32
@@ -293,7 +293,7 @@ LibPcdGetEx32 ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINT64 Return the UINT64.
+ @return Return the UINT64.
**/
UINT64
@@ -317,7 +317,7 @@ LibPcdGetEx64 ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval VOID* Return the VOID* pointer.
+ @return Return the VOID* pointer.
**/
VOID *
@@ -342,7 +342,7 @@ LibPcdGetExPtr ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval BOOLEAN Return the BOOLEAN.
+ @return Return the BOOLEAN.
**/
BOOLEAN
@@ -366,7 +366,7 @@ LibPcdGetExBool ( which namespace to retrieve a value from.
@param[in] TokenNumber The PCD token number to retrieve a current value for.
- @retval UINTN Return the size.
+ @return Return the size.
**/
UINTN
@@ -390,7 +390,7 @@ LibPcdGetExSize ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
- @retval UINT8 Return the value been set.
+ @return Return the value been set.
**/
UINT8
@@ -419,7 +419,7 @@ LibPcdSet8 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
- @retval UINT16 Return the value been set.
+ @return Return the value been set.
**/
UINT16
@@ -448,7 +448,7 @@ LibPcdSet16 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
- @retval UINT32 Return the value been set.
+ @return Return the value been set.
**/
UINT32
@@ -477,7 +477,7 @@ LibPcdSet32 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
- @retval UINT64 Return the value been set.
+ @return Return the value been set.
**/
UINT64
@@ -517,7 +517,7 @@ LibPcdSet64 ( In out, returns actual size of buffer is set.
@param[in] Buffer A pointer to the buffer to set.
- @retval VOID* Return the pointer for the buffer been set.
+ @return Return the pointer for the buffer been set.
**/
VOID *
@@ -555,7 +555,7 @@ LibPcdSetPtr ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The boolean value to set.
- @retval BOOLEAN Return the value been set.
+ @return Return the value been set.
**/
BOOLEAN
@@ -587,7 +587,7 @@ LibPcdSetBool ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
- @retval UINT8 Return the value been set.
+ @return Return the value been set.
**/
UINT8
@@ -622,7 +622,7 @@ LibPcdSetEx8 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
- @retval UINT16 Return the value been set.
+ @return Return the value been set.
**/
UINT16
@@ -655,7 +655,7 @@ LibPcdSetEx16 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
- @retval UINT32 Return the value been set.
+ @return Return the value been set.
**/
UINT32
@@ -690,7 +690,7 @@ LibPcdSetEx32 ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
- @retval UINT64 Return the value been set.
+ @return Return the value been set.
**/
UINT64
@@ -729,7 +729,7 @@ LibPcdSetEx64 ( In out, returns actual size of buffer is set.
@param[in] Buffer A pointer to the buffer to set.
- @retval VOID * Return the pinter to the buffer been set.
+ @return Return the pinter to the buffer been set.
**/
VOID *
@@ -770,7 +770,7 @@ LibPcdSetExPtr ( @param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The Boolean value to set.
- @retval Boolean Return the value been set.
+ @return Return the value been set.
**/
BOOLEAN
@@ -873,7 +873,7 @@ LibPcdCancelCallback ( @param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD
token number.
- @retval UINTN The next valid token number.
+ @return The next valid token number.
**/
UINTN
@@ -908,7 +908,7 @@ LibPcdGetNextToken ( @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.
+ @return The next valid token namespace.
**/
GUID *
@@ -946,6 +946,8 @@ LibPcdGetNextTokenSpace ( @param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.
In out, returns actual size of buffer is set.
@param[in] Buffer A pointer to the buffer to used to set the target variable.
+
+ @return Return the pinter to the buffer been set.
**/
VOID *
|