Update comment for return description for PcdSetX macros.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8474 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Library/PcdLib.h b/MdePkg/Include/Library/PcdLib.h
index 6187935bf6562d6554ab6d222d2affc64ea22ba8..3b0f830e7f96023838a1289d66d725f545c3f074 100644 (file)
--- a/MdePkg/Include/Library/PcdLib.h
+++ b/MdePkg/Include/Library/PcdLib.h
@@ -250,7 +250,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   TokenName  The name of the binary patchable PCD token to set the current value for.\r
   @param   Value      The 8-bit value to set.\r
   \r
-  @return  Value.\r
+  @return Return the Value that was set.\r
 \r
 **/\r
 #define PatchPcdSet8(TokenName, Value)      (_gPcd_BinaryPatch_##TokenName = (Value))\r
@@ -266,7 +266,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   TokenName  The name of the binary patchable PCD token to set the current value for.\r
   @param   Value      The 16-bit value to set.\r
 \r
-  @return  Value.\r
+  @return Return the Value that was set.\r
 \r
 **/\r
 #define PatchPcdSet16(TokenName, Value)     (_gPcd_BinaryPatch_##TokenName = (Value))\r
@@ -282,7 +282,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   TokenName  The name of the binary patchable PCD token to set the current value for.\r
   @param   Value      The 32-bit value to set.\r
 \r
-  @return  Value.\r
+  @return Return the Value that was set.\r
 \r
 **/\r
 #define PatchPcdSet32(TokenName, Value)     (_gPcd_BinaryPatch_##TokenName = (Value))\r
@@ -298,7 +298,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   TokenName  The name of the binary patchable PCD token to set the current value for.\r
   @param   Value      The 64-bit value to set.\r
 \r
-  @return  Value.\r
+  @return Return the Value that was set.\r
 \r
 **/\r
 #define PatchPcdSet64(TokenName, Value)     (_gPcd_BinaryPatch_##TokenName = (Value))\r
@@ -314,7 +314,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   TokenName  The name of the binary patchable PCD token to set the current value for.\r
   @param   Value      The boolean value to set.\r
 \r
-  @return  Value.\r
+  @return Return the Value that was set.\r
 \r
 **/\r
 #define PatchPcdSetBool(TokenName, Value)   (_gPcd_BinaryPatch_##TokenName = (Value))\r
@@ -338,7 +338,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   SizeOfBuffer   A pointer to the size, in bytes, of Buffer.\r
   @param   Buffer         Pointer to the value to set.\r
 \r
-  @return  Value.\r
+  @return Return the pointer to the Buffer that was set.\r
 \r
 **/\r
 #define PatchPcdSetPtr(TokenName, Size, Buffer) \\r
@@ -442,7 +442,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
   @param   Value      The 8-bit value to set.\r
   \r
-  @return  Value.\r
+  @return Return the Value that was set.\r
 \r
 **/\r
 #define PcdSet8(TokenName, Value)           _PCD_SET_MODE_8_##TokenName     ((Value))\r
@@ -457,7 +457,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
   @param   Value      The 16-bit value to set.\r
 \r
-  @return  Value.\r
+  @return Return the Value that was set.\r
 \r
 **/\r
 #define PcdSet16(TokenName, Value)          _PCD_SET_MODE_16_##TokenName    ((Value))\r
@@ -472,7 +472,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
   @param   Value      The 32-bit value to set.\r
 \r
-  @return  Value.\r
+  @return Return the Value that was set.\r
 \r
 **/\r
 #define PcdSet32(TokenName, Value)          _PCD_SET_MODE_32_##TokenName    ((Value))\r
@@ -487,7 +487,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
   @param   Value      The 64-bit value to set.\r
 \r
-  @return  Value.\r
+  @return Return the Value that was set.\r
 \r
 **/\r
 #define PcdSet64(TokenName, Value)          _PCD_SET_MODE_64_##TokenName    ((Value))\r
@@ -511,7 +511,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   SizeOfBuffer   A pointer to the size, in bytes, of Buffer.\r
   @param   Buffer         A pointer to the buffer to set.\r
 \r
-  @return  Buffer.\r
+  @return Return the pointer to the Buffer that was set.\r
 \r
 **/\r
 #define PcdSetPtr(TokenName, SizeOfBuffer, Buffer) \\r
@@ -526,7 +526,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   TokenName      The name of the PCD token to set the current value for.\r
   @param   Buffer         The Boolean value to set.\r
 \r
-  @return  Value. \r
+  @return Return the Value that was set.\r
 \r
 **/\r
 #define PcdSetBool(TokenName, Value)        _PCD_SET_MODE_BOOL_##TokenName  ((Value))\r
@@ -660,7 +660,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   TokenName   The name of the PCD token to set the current value for.\r
   @param   Value       The 8-bit value to set.                   \r
 \r
-  @return  Value. \r
+  @return Return the Value that was set.\r
 \r
 **/\r
 #define PcdSetEx8(Guid, TokenName, Value)   LibPcdSetEx8   ((Guid), _PCD_TOKEN_##TokenName, (Value))\r
@@ -680,7 +680,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   TokenName   The name of the PCD token to set the current value for.\r
   @param   Value       The 16-bit value to set.                   \r
 \r
-  @return  Value. \r
+  @return Return the Value that was set.\r
 \r
 **/\r
 #define PcdSetEx16(Guid, TokenName, Value)  LibPcdSetEx16  ((Guid), _PCD_TOKEN_##TokenName, (Value))\r
@@ -700,7 +700,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   TokenName   The name of the PCD token to set the current value for.\r
   @param   Value       The 32-bit value to set.                   \r
 \r
-  @return  Value. \r
+  @return Return the Value that was set.\r
 \r
 **/\r
 #define PcdSetEx32(Guid, TokenName, Value)  LibPcdSetEx32  ((Guid), _PCD_TOKEN_##TokenName, (Value))\r
@@ -720,7 +720,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   TokenName   The name of the PCD token to set the current value for.\r
   @param   Value       The 64-bit value to set.                   \r
 \r
-  @return  Value. \r
+  @return Return the Value that was set.\r
 \r
 **/\r
 #define PcdSetEx64(Guid, TokenName, Value)  LibPcdSetEx64  ((Guid), _PCD_TOKEN_##TokenName, (Value))\r
@@ -746,9 +746,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
                           which namespace to retrieve a value from.\r
   @param   TokenName      The name of the PCD token to set the current value for.\r
   @param   SizeOfBuffer   A pointer to the size, in bytes, of Buffer.                  \r
-  @param   Value          Pointer to the buffer to set.\r
+  @param   Buffer         Pointer to the buffer to set.\r
     \r
-  @return  Buffer. \r
+  @return Return the pointer to the Buffer that was set.\r
 \r
 **/\r
 #define PcdSetExPtr(Guid, TokenName, SizeOfBuffer, Buffer) \\r
@@ -769,7 +769,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param   TokenName      The name of the PCD token to set the current value for.              \r
   @param   Value          The Boolean value to set.\r
 \r
-  @return  Value. \r
+  @return Return the Value that was set.\r
 \r
 **/                                         \r
 #define PcdSetExBool(Guid, TokenName, Value) \\r