Function comments have been checked with spec.

[mirror_edk2.git] / MdePkg / Library / DxePcdLib / DxePcdLib.c

diff --git a/MdePkg/Library/DxePcdLib/DxePcdLib.c b/MdePkg/Library/DxePcdLib/DxePcdLib.c
index e780bd32a24d0b3a4103388177767e3767599310..987a2e91654643fe3f30507561246d65bd968843 100644 (file)
--- 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 \r
                         set values.\r
 \r
-  @retval SKU_ID Return the SKU ID that just be set.\r
+  @return Return the SKU ID that just be set.\r
 \r
 **/\r
 UINTN\r
@@ -86,7 +86,7 @@ LibPcdSetSku (
 \r
   @param[in]  TokenNumber   The PCD token number to retrieve a current value for.\r
 \r
-  @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber. \r
+  @return Returns the 8-bit value for the token specified by TokenNumber. \r
 \r
 **/\r
 UINT8\r
@@ -105,7 +105,7 @@ LibPcdGet8 (
 \r
   @param[in]  TokenNumber   The PCD token number to retrieve a current value for.\r
 \r
-  @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber. \r
+  @return Returns the 16-bit value for the token specified by TokenNumber. \r
 \r
 **/\r
 UINT16\r
@@ -124,7 +124,7 @@ LibPcdGet16 (
 \r
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
-  @retval UINT32 Returns the 32-bit value for the token specified by TokenNumber.\r
+  @return Returns the 32-bit value for the token specified by TokenNumber.\r
 \r
 **/\r
 UINT32\r
@@ -143,7 +143,7 @@ LibPcdGet32 (
 \r
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
-  @retval UINT64 Returns the 64-bit value for the token specified by TokenNumber.\r
+  @return Returns the 64-bit value for the token specified by TokenNumber.\r
 \r
 **/\r
 UINT64\r
@@ -162,7 +162,7 @@ LibPcdGet64 (
 \r
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
-  @retval VOID* Returns the pointer to the token specified by TokenNumber.\r
+  @return Returns the pointer to the token specified by TokenNumber.\r
 \r
 **/\r
 VOID *\r
@@ -181,7 +181,7 @@ LibPcdGetPtr (
 \r
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
-  @retval BOOLEAN Returns the Boolean value of the token specified by TokenNumber. \r
+  @return Returns the Boolean value of the token specified by TokenNumber. \r
 \r
 **/\r
 BOOLEAN \r
@@ -200,7 +200,7 @@ LibPcdGetBool (
 \r
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
-  @retval UINTN Returns the size of the token specified by TokenNumber. \r
+  @return Returns the size of the token specified by TokenNumber. \r
 \r
 **/\r
 UINTN\r
@@ -222,7 +222,7 @@ LibPcdGetSize (
               which namespace to retrieve a value from.\r
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
-  @retval UINT8 Return the UINT8.\r
+  @return Return the UINT8.\r
 \r
 **/\r
 UINT8\r
@@ -246,7 +246,7 @@ LibPcdGetEx8 (
               which namespace to retrieve a value from.\r
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
-  @retval UINT16 Return the UINT16.\r
+  @return Return the UINT16.\r
 \r
 **/\r
 UINT16\r
@@ -270,7 +270,7 @@ LibPcdGetEx16 (
               which namespace to retrieve a value from.\r
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
-  @retval UINT32 Return the UINT32.\r
+  @return Return the UINT32.\r
 \r
 **/\r
 UINT32\r
@@ -295,7 +295,7 @@ LibPcdGetEx32 (
               which namespace to retrieve a value from.\r
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
-  @retval UINT64 Return the UINT64.\r
+  @return Return the UINT64.\r
 \r
 **/\r
 UINT64\r
@@ -320,7 +320,7 @@ LibPcdGetEx64 (
               which namespace to retrieve a value from.\r
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
-  @retval VOID* Return the VOID* pointer.\r
+  @return Return the VOID* pointer.\r
 \r
 **/\r
 VOID *\r
@@ -345,7 +345,7 @@ LibPcdGetExPtr (
               which namespace to retrieve a value from.\r
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
-  @retval BOOLEAN Return the BOOLEAN.\r
+  @return Return the BOOLEAN.\r
 \r
 **/\r
 BOOLEAN\r
@@ -370,7 +370,7 @@ LibPcdGetExBool (
               which namespace to retrieve a value from.\r
   @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
 \r
-  @retval UINTN Return the size.\r
+  @return Return the size.\r
 \r
 **/\r
 UINTN\r
@@ -395,7 +395,7 @@ LibPcdGetExSize (
   @param[in]  TokenNumber The PCD token number to set a current value for.\r
   @param[in]  Value The 8-bit value to set.\r
 \r
-  @retval UINT8 Return the value been set.\r
+  @return Return the value been set.\r
 \r
 **/\r
 UINT8\r
@@ -424,7 +424,7 @@ LibPcdSet8 (
   @param[in]  TokenNumber The PCD token number to set a current value for.\r
   @param[in]  Value The 16-bit value to set.\r
 \r
-  @retval UINT16 Return the value been set.\r
+  @return Return the value been set.\r
 \r
 **/\r
 UINT16\r
@@ -453,7 +453,7 @@ LibPcdSet16 (
   @param[in]  TokenNumber The PCD token number to set a current value for.\r
   @param[in]  Value The 32-bit value to set.\r
 \r
-  @retval UINT32 Return the value been set.\r
+  @return Return the value been set.\r
 \r
 **/\r
 UINT32\r
@@ -481,7 +481,7 @@ LibPcdSet32 (
   @param[in]  TokenNumber The PCD token number to set a current value for.\r
   @param[in]  Value The 64-bit value to set.\r
 \r
-  @retval UINT64 Return the value been set.\r
+  @return Return the value been set.\r
 \r
 **/\r
 UINT64\r
@@ -514,14 +514,14 @@ LibPcdSet64 (
   maximum size supported by TokenNumber and return NULL to \r
   indicate that the set operation was not actually performed. \r
   \r
-  If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
+  If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
   \r
   @param[in]      TokenNumber   The PCD token number to set a current value for.\r
   @param[in, out] SizeOfBuffer  The size, in bytes, of Buffer.\r
                                 In out, returns actual size of buff is set. \r
   @param[in]      Buffer        A pointer to the buffer to set.\r
 \r
-  @retval VOID* Return the pointer for the buffer been set.\r
+  @return Return the pointer for the buffer been set.\r
 \r
 **/\r
 VOID *\r
@@ -559,7 +559,7 @@ LibPcdSetPtr (
   @param[in]  TokenNumber The PCD token number to set a current value for.\r
   @param[in]  Value       The boolean value to set.\r
 \r
-  @retval BOOLEAN Return the value been set.\r
+  @return Return the value been set.\r
 \r
 **/\r
 BOOLEAN\r
@@ -591,7 +591,7 @@ LibPcdSetBool (
   @param[in]  TokenNumber The PCD token number to set a current value for.\r
   @param[in]  Value The 8-bit value to set.\r
 \r
-  @retval UINT8 Return the value been set.\r
+  @return Return the value been set.\r
 \r
 **/\r
 UINT8\r
@@ -626,7 +626,7 @@ LibPcdSetEx8 (
   @param[in]  TokenNumber The PCD token number to set a current value for.\r
   @param[in]  Value The 16-bit value to set.\r
 \r
-  @retval UINT16 Return the value been set.\r
+  @return Return the value been set.\r
 \r
 **/\r
 UINT16\r
@@ -661,7 +661,7 @@ LibPcdSetEx16 (
   @param[in]  TokenNumber The PCD token number to set a current value for.\r
   @param[in]  Value The 32-bit value to set.\r
 \r
-  @retval UINT32 Return the value been set.\r
+  @return Return the value been set.\r
 \r
 **/\r
 UINT32\r
@@ -695,7 +695,7 @@ LibPcdSetEx32 (
   @param[in]  TokenNumber The PCD token number to set a current value for.\r
   @param[in]  Value The 64-bit value to set.\r
 \r
-  @retval UINT64 Return the value been set.\r
+  @return Return the value been set.\r
 \r
 **/\r
 UINT64\r
@@ -735,7 +735,7 @@ LibPcdSetEx64 (
                     In out, returns actual size of buffer is set.\r
   @param[in]        Buffer A pointer to the buffer to set.\r
 \r
-  @retval VOID * Return the pinter to the buffer been set.\r
+  @return Return the pinter to the buffer been set.\r
 \r
 **/\r
 VOID *\r
@@ -779,7 +779,7 @@ LibPcdSetExPtr (
   @param[in]  TokenNumber The PCD token number to set a current value for.\r
   @param[in]  Value The Boolean value to set.\r
 \r
-  @retval Boolean Return the value been set.\r
+  @return Return the value been set.\r
 \r
 **/\r
 BOOLEAN\r
@@ -816,9 +816,6 @@ LibPcdSetExBool (
   @param[in]  TokenNumber The PCD token number to monitor.\r
   @param[in]  NotificationFunction The function to call when the token \r
               specified by Guid and TokenNumber is set.\r
-\r
-  @retval VOID\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -850,8 +847,6 @@ LibPcdCallbackOnSet (
   @param[in]  TokenNumber Specify the token number.\r
   @param[in]  NotificationFunction The callback function to be unregistered.\r
 \r
-  @retval VOID\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -888,7 +883,7 @@ LibPcdCancelCallback (
   @param[in]  TokenNumber The previous PCD token number.  If 0, then retrieves the first PCD \r
                           token number.\r
 \r
-  @retval UINTN            The next valid token number.\r
+  @return The next valid token number.\r
 \r
 **/\r
 UINTN                      \r
@@ -922,7 +917,7 @@ LibPcdGetNextToken (
   @param[in]  Guid  Pointer to a 128-bit unique value that designates from which namespace \r
                     to start the search.\r
 \r
-  @retval CONST GUID *  The next valid token namespace.\r
+  @return The next valid token namespace.\r
 \r
 **/\r
 GUID *           \r
@@ -960,6 +955,9 @@ LibPcdGetNextTokenSpace (
                                 In out, returns actual size of buffer is set.\r
   @param[in] Buffer             A pointer to the buffer to used to set the target variable.\r
 \r
+  @return Return the pinter to the buffer been set.\r
+  @retval NULL   If SizeOfBuffer is set to MAX_ADDRESS or larger than MaximumDatumSize, \r
+                 then SizeOfBuffer must be set to MaximumDatumSize and NULL must be returned.\r
 **/\r
 VOID *\r
 EFIAPI\r