Coding style fix.

[mirror_edk2.git] / MdePkg / Include / Library / PcdLib.h

diff --git a/MdePkg/Include/Library/PcdLib.h b/MdePkg/Include/Library/PcdLib.h
index a856b3fbe1ee2cbe72d8333a20499ed0e78378d3..858c863749f20b433010f0547294c606a5c81baa 100644 (file)
--- a/MdePkg/Include/Library/PcdLib.h
+++ b/MdePkg/Include/Library/PcdLib.h
@@ -23,9 +23,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #ifndef __PCD_LIB_H__\r
 #define __PCD_LIB_H__\r
 \r
-#include <Base.h>\r
-\r
-#define PCD_INVALID_TOKEN_NUMBER ((UINTN) 0)\r
 #define PCD_MAX_SKU_ID           0x100\r
 \r
 #define PcdToken(TokenName)                 _PCD_TOKEN_##TokenName\r
@@ -124,7 +121,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 \r
                     set values associated with a PCD token.\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
@@ -139,7 +136,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
@@ -154,7 +151,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
@@ -169,7 +166,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
@@ -184,7 +181,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
@@ -199,7 +196,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
@@ -214,7 +211,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
@@ -229,7 +226,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
@@ -247,7 +244,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
@@ -266,7 +263,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
@@ -285,7 +282,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
@@ -304,7 +301,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
@@ -323,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
@@ -342,7 +339,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
@@ -361,7 +358,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
@@ -379,7 +376,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
@@ -397,7 +394,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
@@ -415,7 +412,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
@@ -433,7 +430,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
@@ -446,22 +443,22 @@ LibPcdSet64 (
 \r
 /**\r
   Sets a buffer for the token specified by TokenNumber to the value \r
-  specified by Buffer and SizeOfValue.  Buffer is returned.  \r
-  If SizeOfValue is greater than the maximum size support by TokenNumber, \r
-  then set SizeOfValue to the maximum size supported by TokenNumber and \r
+  specified by Buffer and SizeOfBuffer.  Buffer is returned.  \r
+  If SizeOfBuffer is greater than the maximum size support by TokenNumber, \r
+  then set SizeOfBuffer to the maximum size supported by TokenNumber and \r
   return NULL to indicate that the set operation was not actually performed.  \r
 \r
-  If SizeOfValue is set to MAX_ADDRESS, then SizeOfValue must be set to the \r
+  If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the \r
   maximum size supported by TokenName and NULL must be returned.\r
   \r
-  If SizeOfValue is NULL, then ASSERT().\r
-  If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
+  If SizeOfBuffer 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
   @param[in]      Buffer        Value 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
@@ -480,7 +477,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
@@ -501,7 +498,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
@@ -523,7 +520,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 UINT8 Return the value been set.\r
+  @return Return the value been set.\r
 \r
 **/\r
 UINT16\r
@@ -545,7 +542,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
@@ -567,7 +564,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
@@ -581,14 +578,14 @@ LibPcdSetEx64 (
 \r
 /**\r
   Sets a buffer for the token specified by TokenNumber to the value specified by \r
-  Buffer and SizeOfValue.  Buffer is returned.  If SizeOfValue is greater than \r
-  the maximum size support by TokenNumber, then set SizeOfValue to the maximum size \r
+  Buffer and SizeOfBuffer.  Buffer is returned.  If SizeOfBuffer is greater than \r
+  the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size \r
   supported by TokenNumber and return NULL to indicate that the set operation \r
   was not actually performed. \r
   \r
   If Guid is NULL, then ASSERT().\r
-  If SizeOfValue is NULL, then ASSERT().\r
-  If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
+  If SizeOfBuffer is NULL, then ASSERT().\r
+  If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
   \r
   @param[in]  Guid              Pointer to a 128-bit unique value that \r
                                 designates which namespace to set a value from.\r
@@ -596,7 +593,7 @@ LibPcdSetEx64 (
   @param[in, out] SizeOfBuffer  The size, in bytes, of Buffer.\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
@@ -619,7 +616,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
@@ -714,7 +711,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
@@ -740,7 +737,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
@@ -752,21 +749,23 @@ LibPcdGetNextTokenSpace (
 \r
 /**\r
   Sets the PCD entry specified by PatchVariable to the value specified by Buffer \r
-  and SizeOfValue.  Buffer is returned.  If SizeOfValue is greater than \r
-  MaximumDatumSize, then set SizeOfValue to MaximumDatumSize and return \r
+  and SizeOfBuffer.  Buffer is returned.  If SizeOfBuffer is greater than \r
+  MaximumDatumSize, then set SizeOfBuffer to MaximumDatumSize and return \r
   NULL to indicate that the set operation was not actually performed.  \r
-  If SizeOfValue is set to MAX_ADDRESS, then SizeOfValue must be set to \r
+  If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to \r
   MaximumDatumSize and NULL must be returned.\r
   \r
   If PatchVariable is NULL, then ASSERT().\r
-  If SizeOfValue is NULL, then ASSERT().\r
-  If SizeOfValue > 0 and Buffer is NULL, then ASSERT().\r
+  If SizeOfBuffer is NULL, then ASSERT().\r
+  If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
 \r
   @param[in] PatchVariable      A pointer to the global variable in a module that is \r
                                 the target of the set operation.\r
   @param[in] MaximumDatumSize   The maximum size allowed for the PCD entry specified by PatchVariable.\r
   @param[in, out] SizeOfBuffer  A pointer to the size, in bytes, of Buffer.\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
 \r
 **/\r
 VOID *\r