MdePkg: Correct comments of macros FixedPcdGetX/PatchPcdXXX in PcdLib.h

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=311

The patch is also to refine comments of macros PcdToken and PcdTokenEx.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael Kinney <michael.d.kinney@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>

diff --git a/MdePkg/Include/Library/PcdLib.h b/MdePkg/Include/Library/PcdLib.h
index 4def328862941fdfd2b1798eb018e4fdb90e1c03..9e7e09f52cdc3dc7d2c0b474f5804c06b0d410a3 100644 (file)
--- a/MdePkg/Include/Library/PcdLib.h
+++ b/MdePkg/Include/Library/PcdLib.h
@@ -14,7 +14,7 @@
   There are no restrictions on the use of FeaturePcd(), FixedPcdGetXX(),\r
   PatchPcdGetXX(), and PatchPcdSetXX().\r
 \r
-Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -32,9 +32,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 /**\r
   Retrieves a token number based on a token name.\r
 \r
- Returns the token number associated with the PCD token specified by TokenName.\r
+  Returns the token number associated with the PCD token specified by TokenName.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
 \r
   @param   TokenName  The name of the PCD token to retrieve the token number for.\r
 \r
@@ -49,7 +48,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Returns the Boolean value for the PCD feature flag specified by TokenName.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a feature flag PCD, then the module will not build.\r
 \r
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
 \r
@@ -64,7 +63,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Returns the 8-bit value for the token specified by TokenName.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a fixed at build PCD, then the module will not build.\r
 \r
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
 \r
@@ -79,7 +78,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Returns the 16-bit value for the token specified by TokenName.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a fixed at build PCD, then the module will not build.\r
 \r
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
 \r
@@ -94,7 +93,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Returns the 32-bit value for the token specified by TokenName.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a fixed at build PCD, then the module will not build.\r
 \r
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
 \r
@@ -109,7 +108,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Returns the 64-bit value for the token specified by TokenName.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a fixed at build PCD, then the module will not build.\r
 \r
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
 \r
@@ -124,7 +123,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Returns the Boolean value for the token specified by TokenName.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a fixed at build PCD, then the module will not build.\r
 \r
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
 \r
@@ -139,7 +138,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Returns a pointer to the buffer for the token specified by TokenName.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a fixed at build PCD, then the module will not build.\r
 \r
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
 \r
@@ -154,7 +153,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Returns the 8-bit value for the token specified by TokenName.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a patchable in module PCD, then the module will not build.\r
 \r
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
 \r
@@ -168,7 +167,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Returns the 16-bit value for the token specified by TokenName.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a patchable in module PCD, then the module will not build.\r
 \r
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
 \r
@@ -183,7 +182,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Returns the 32-bit value for the token specified by TokenName.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a patchable in module PCD, then the module will not build.\r
 \r
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
 \r
@@ -198,7 +197,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Returns the 64-bit value for the token specified by TokenName.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a patchable in module PCD, then the module will not build.\r
 \r
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
 \r
@@ -213,7 +212,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Returns the Boolean value for the token specified by TokenName.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a patchable in module PCD, then the module will not build.\r
 \r
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
 \r
@@ -228,7 +227,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Returns a pointer to the buffer for the token specified by TokenName.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a patchable in module PCD, then the module will not build.\r
 \r
   @param   TokenName  The name of the PCD token to retrieve a current value for.\r
 \r
@@ -243,7 +242,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Sets the 8-bit value for the token specified by TokenName. Value is returned.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a patchable in module PCD, then the module will not build.\r
 \r
   @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
@@ -259,7 +258,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Sets the 16-bit value for the token specified by TokenName. Value is returned.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a patchable in module PCD, then the module will not build.\r
 \r
   @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
@@ -275,7 +274,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Sets the 32-bit value for the token specified by TokenName. Value is returned.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a patchable in module PCD, then the module will not build.\r
 \r
   @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
@@ -291,7 +290,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Sets the 64-bit value for the token specified by TokenName. Value is returned.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a patchable in module PCD, then the module will not build.\r
 \r
   @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
@@ -307,7 +306,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   Sets the Boolean value for the token specified by TokenName. Value is returned.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a patchable in module PCD, then the module will not build.\r
 \r
   @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
@@ -327,7 +326,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   was not actually performed.  If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be \r
   set to the maximum size supported by TokenName and NULL must be returned.\r
   If TokenName is not a valid token in the token space, then the module will not build.\r
-  If TokenName is not a feature flag, then the module will not build.\r
+  If TokenName is not a patchable in module PCD, then the module will not build.\r
   \r
   If SizeOfBuffer is NULL, then ASSERT().\r
   If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().\r
@@ -688,6 +687,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   Retrieves a token number based on a GUID and a token name.\r
 \r
   Returns the token number for the token specified by Guid and TokenName.\r
+  If TokenName is not a valid token in the token space, then the module will not build.\r
 \r
   @param   Guid        Pointer to a 128-bit unique value that designates \r
                        which namespace to retrieve a value from.\r