From 63e4dba96ab826bfcd51a98f551c103bc3d3ba3b Mon Sep 17 00:00:00 2001 From: klu2 Date: Wed, 16 Jul 2008 09:29:20 +0000 Subject: [PATCH] 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 --- MdePkg/Include/Protocol/Pcd.h | 3 ++- MdePkg/Library/DxePcdLib/DxePcdLib.c | 2 +- MdePkg/Library/PeiPcdLib/PeiPcdLib.c | 27 +++++++++++---------------- 3 files changed, 14 insertions(+), 18 deletions(-) diff --git a/MdePkg/Include/Protocol/Pcd.h b/MdePkg/Include/Protocol/Pcd.h index abccf87b4d..9344ad2262 100644 --- a/MdePkg/Include/Protocol/Pcd.h +++ b/MdePkg/Include/Protocol/Pcd.h @@ -252,7 +252,8 @@ UINT16 @return The size 32-bit value for the PCD token. -**/typedef +**/ +typedef UINT32 (EFIAPI *PCD_PROTOCOL_GET_EX_32)( IN CONST EFI_GUID *Guid, diff --git a/MdePkg/Library/DxePcdLib/DxePcdLib.c b/MdePkg/Library/DxePcdLib/DxePcdLib.c index 10d6a20381..ccf7b7d213 100644 --- a/MdePkg/Library/DxePcdLib/DxePcdLib.c +++ b/MdePkg/Library/DxePcdLib/DxePcdLib.c @@ -518,7 +518,7 @@ 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, 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. diff --git a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c index ea65581ebc..1695ca561d 100644 --- a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c +++ b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c @@ -29,12 +29,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. /** The constructor function retrieve the PCD_PPI pointer. - @param[in] VOID - @retval PCD_PPI * The pointer to the PCD_PPI. **/ -STATIC PCD_PPI * GetPcdPpiPtr ( VOID @@ -49,8 +46,6 @@ GetPcdPpiPtr ( return PcdPpi; } - - /** 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. - @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. @@ -102,7 +97,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. @@ -579,9 +574,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. @@ -956,10 +951,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. @@ -996,8 +991,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. -- 2.39.2