mirror of https://github.com/acidanthera/audk.git
Fix function comment to follows doxygen format.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5497 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
parent
f8d709956f
commit
63e4dba96a
|
@ -252,7 +252,8 @@ UINT16
|
||||||
|
|
||||||
@return The size 32-bit value for the PCD token.
|
@return The size 32-bit value for the PCD token.
|
||||||
|
|
||||||
**/typedef
|
**/
|
||||||
|
typedef
|
||||||
UINT32
|
UINT32
|
||||||
(EFIAPI *PCD_PROTOCOL_GET_EX_32)(
|
(EFIAPI *PCD_PROTOCOL_GET_EX_32)(
|
||||||
IN CONST EFI_GUID *Guid,
|
IN CONST EFI_GUID *Guid,
|
||||||
|
|
|
@ -29,12 +29,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
/**
|
/**
|
||||||
The constructor function retrieve the PCD_PPI pointer.
|
The constructor function retrieve the PCD_PPI pointer.
|
||||||
|
|
||||||
@param[in] VOID
|
|
||||||
|
|
||||||
@retval PCD_PPI * The pointer to the PCD_PPI.
|
@retval PCD_PPI * The pointer to the PCD_PPI.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
STATIC
|
|
||||||
PCD_PPI *
|
PCD_PPI *
|
||||||
GetPcdPpiPtr (
|
GetPcdPpiPtr (
|
||||||
VOID
|
VOID
|
||||||
|
@ -49,8 +46,6 @@ GetPcdPpiPtr (
|
||||||
return PcdPpi;
|
return PcdPpi;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.
|
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.
|
||||||
|
|
||||||
|
@ -79,7 +74,7 @@ LibPcdSetSku (
|
||||||
/**
|
/**
|
||||||
Returns the 8-bit value for the token specified by TokenNumber.
|
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.
|
@retval UINT8 Returns the 8-bit value for the token specified by TokenNumber.
|
||||||
|
|
||||||
|
@ -102,7 +97,7 @@ LibPcdGet8 (
|
||||||
/**
|
/**
|
||||||
Returns the 16-bit value for the token specified by TokenNumber.
|
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.
|
@retval UINT16 Returns the 16-bit value for the token specified by TokenNumber.
|
||||||
|
|
||||||
|
@ -581,7 +576,7 @@ LibPcdSet64 (
|
||||||
|
|
||||||
@param[in] TokenNumber The PCD token number to set a current value for.
|
@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, out] SizeOfBuffer The size, in bytes, of Buffer.
|
||||||
@param[in] Value A pointer to the buffer to set.
|
@param[in] Buffer A pointer to the buffer to set.
|
||||||
|
|
||||||
@retval VOID* Return the pointer for the buffer been set.
|
@retval VOID* Return the pointer for the buffer been set.
|
||||||
|
|
||||||
|
@ -956,9 +951,9 @@ LibPcdCancelCallback (
|
||||||
token number in the token space, then 0 is returned. If TokenNumber is not 0 and
|
token number in the token space, then 0 is returned. If TokenNumber is not 0 and
|
||||||
is not in the token space specified by Guid, then ASSERT().
|
is not in the token space specified by Guid, then ASSERT().
|
||||||
|
|
||||||
@param[in] Pointer to a 128-bit unique value that designates which namespace
|
@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.
|
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
|
@param[in] TokenNumber The previous PCD token number. If 0, then retrieves the first PCD
|
||||||
token number.
|
token number.
|
||||||
|
|
||||||
@retval UINTN The next valid token number.
|
@retval UINTN The next valid token number.
|
||||||
|
@ -996,7 +991,7 @@ LibPcdGetNextToken (
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@param[in] Pointer to a 128-bit unique value that designates from which namespace
|
@param[in] Guid Pointer to a 128-bit unique value that designates from which namespace
|
||||||
to start the search.
|
to start the search.
|
||||||
|
|
||||||
@retval CONST GUID * The next valid token namespace.
|
@retval CONST GUID * The next valid token namespace.
|
||||||
|
|
Loading…
Reference in New Issue