Second set of changes based on a review of the code comments in the Include directory...

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

diff --git a/MdePkg/Include/Library/PcdLib.h b/MdePkg/Include/Library/PcdLib.h
index 319c751c61589dcb7f9d4bbcd30fb1ffa3fd8c18..20c7765f418ccce3d3048d12967d5b20fc3d3842 100644 (file)
--- a/MdePkg/Include/Library/PcdLib.h
+++ b/MdePkg/Include/Library/PcdLib.h
@@ -1,12 +1,12 @@
 /** @file\r
   Provides library services to get and set Platform Configuration Database entries.\r
 \r
-  PCD Library Class provides PCD usage macro interface for all PCD types.\r
-  It should be included at any module who use PCD. If module use dynamic/dynamicex\r
-  PCD, module should be linked to PEIM/DXE library instance to access that PCD.\r
-  If module uses PatchableInModule type PCD, also need library instance produce\r
-  LibPatchPcdSetPtr() interface. For FeatureFlag/Fixed PCD, macro interface is\r
-  translated to an variable or macro which is auto-generated by build tool in\r
+  PCD Library Class provides a PCD usage macro interface for all PCD types.\r
+  It should be included in any module that uses PCD. If a module uses dynamic/dynamicex\r
+  PCD, module should be linked to a PEIM/DXE library instance to access that PCD.\r
+  If a module uses PatchableInModule type PCD, it also needs the library instance to produce\r
+  LibPatchPcdSetPtr() interface. For FeatureFlag/Fixed PCD, the macro interface is\r
+  translated to n variable or macro that is auto-generated by build tool in\r
   module's autogen.h/autogen.c.\r
   The PcdGetXX(), PcdSetXX(), PcdToken(), and PcdGetNextTokenSpace() operations are \r
   only available prior to ExitBootServices().  If access to PCD values are required \r
@@ -785,7 +785,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   @param  SkuId   The SKU value that will be used when the PCD service retrieves and sets values\r
                   associated with a PCD token.\r
 \r
-  @return  Return the SKU ID that just be set.\r
+  @return  Return the SKU ID that was set.\r
 \r
 **/\r
 UINTN\r
@@ -1072,7 +1072,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
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT8\r
@@ -1092,7 +1092,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
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT16\r
@@ -1112,7 +1112,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
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT32\r
@@ -1132,7 +1132,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
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT64\r
@@ -1162,7 +1162,7 @@ LibPcdSet64 (
   @param[in, out] SizeOfBuffer  The size, in bytes, of Buffer.\r
   @param[in]      Buffer        A pointer to the buffer to set.\r
 \r
-  @return Return the pointer for the buffer been set.\r
+  @return Return the pointer for the buffer that was set.\r
 \r
 **/\r
 VOID *\r
@@ -1183,7 +1183,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
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1207,7 +1207,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
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT8\r
@@ -1232,7 +1232,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
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT16\r
@@ -1257,7 +1257,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
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT32\r
@@ -1281,7 +1281,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
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 UINT64\r
@@ -1312,7 +1312,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
-  @return Return the pinter to the buffer been set.\r
+  @return Return the pointer to the buffer that was set.\r
 \r
 **/\r
 VOID *\r
@@ -1338,7 +1338,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
-  @return Return the value been set.\r
+  @return Return the value that was set.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1353,9 +1353,9 @@ LibPcdSetExBool (
 /**\r
   This notification function serves two purposes.\r
 \r
-  Firstly, it notifies the module which did the registration that the value of this\r
+  Firstly, it notifies the module that did the registration that the value of this\r
   PCD token has been set.\r
-  Secondly, it provides a mechanism for the module which did the registration to intercept\r
+  Secondly, it provides a mechanism for the module that did the registration to intercept\r
   the set operation and override the value been set if necessary. After the invocation of\r
   the callback function, TokenData will be used by PCD service PEIM or driver to modify th\r
   internal data in PCD database. \r
@@ -1491,7 +1491,7 @@ LibPcdGetNextTokenSpace (
   @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 pointer to the buffer been set.\r
+  @return Return the pointer to the buffer that was set.\r
 \r
 **/\r
 VOID *\r