From f73e0ad215de60ef1f3b1fac6b5c880da38edef0 Mon Sep 17 00:00:00 2001 From: eric_tian Date: Tue, 16 Sep 2008 06:01:21 +0000 Subject: follow up code review git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5893 6f19259b-4bc3-4df7-8a09-765794883524 --- MdePkg/Library/DxePcdLib/DxePcdLib.c | 60 +++++++++++++++++++----------------- 1 file changed, 31 insertions(+), 29 deletions(-) (limited to 'MdePkg/Library/DxePcdLib') 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 -- cgit v1.2.3