follow up code review
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5893 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@@ -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 *
|
||||
|
Reference in New Issue
Block a user