sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Second set of changes based on a review of the code comments in the Include directory for typos, grammar issues, and language clarity.

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8467 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
pkandel
2009-06-04 16:16:15 +00:00
parent 7076244ef4
commit 1a2f870c9b
38 changed files with 268 additions and 307 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
MdePkg/Include/Library/PcdLib.h
View File

@@ -1,12 +1,12 @@
/** @file
Provides library services to get and set Platform Configuration Database entries.
PCD Library Class provides PCD usage macro interface for all PCD types.
It should be included at any module who use PCD. If module use dynamic/dynamicex
PCD, module should be linked to PEIM/DXE library instance to access that PCD.
If module uses PatchableInModule type PCD, also need library instance produce
LibPatchPcdSetPtr() interface. For FeatureFlag/Fixed PCD, macro interface is
translated to an variable or macro which is auto-generated by build tool in
PCD Library Class provides a PCD usage macro interface for all PCD types.
It should be included in any module that uses PCD. If a module uses dynamic/dynamicex
PCD, module should be linked to a PEIM/DXE library instance to access that PCD.
If a module uses PatchableInModule type PCD, it also needs the library instance to produce
LibPatchPcdSetPtr() interface. For FeatureFlag/Fixed PCD, the macro interface is
translated to n variable or macro that is auto-generated by build tool in
module's autogen.h/autogen.c.
The PcdGetXX(), PcdSetXX(), PcdToken(), and PcdGetNextTokenSpace() operations are
only available prior to ExitBootServices(). If access to PCD values are required
@@ -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
associated with a PCD token.
@return Return the SKU ID that just be set.
@return Return the SKU ID that was set.
**/
UINTN
@@ -1072,7 +1072,7 @@ LibPcdGetExSize (
@param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
@return Return the value been set.
@return Return the value that was set.
**/
UINT8
@@ -1092,7 +1092,7 @@ LibPcdSet8 (
@param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
@return Return the value been set.
@return Return the value that was set.
**/
UINT16
@@ -1112,7 +1112,7 @@ LibPcdSet16 (
@param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
@return Return the value been set.
@return Return the value that was set.
**/
UINT32
@@ -1132,7 +1132,7 @@ LibPcdSet32 (
@param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
@return Return the value been set.
@return Return the value that was set.
**/
UINT64
@@ -1162,7 +1162,7 @@ LibPcdSet64 (
@param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
@param[in] Buffer A pointer to the buffer to set.
@return Return the pointer for the buffer been set.
@return Return the pointer for the buffer that was set.
**/
VOID *
@@ -1183,7 +1183,7 @@ LibPcdSetPtr (
@param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The boolean value to set.
@return Return the value been set.
@return Return the value that was set.
**/
BOOLEAN
@@ -1207,7 +1207,7 @@ LibPcdSetBool (
@param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 8-bit value to set.
@return Return the value been set.
@return Return the value that was set.
**/
UINT8
@@ -1232,7 +1232,7 @@ LibPcdSetEx8 (
@param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 16-bit value to set.
@return Return the value been set.
@return Return the value that was set.
**/
UINT16
@@ -1257,7 +1257,7 @@ LibPcdSetEx16 (
@param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 32-bit value to set.
@return Return the value been set.
@return Return the value that was set.
**/
UINT32
@@ -1281,7 +1281,7 @@ LibPcdSetEx32 (
@param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The 64-bit value to set.
@return Return the value been set.
@return Return the value that was set.
**/
UINT64
@@ -1312,7 +1312,7 @@ LibPcdSetEx64 (
@param[in, out] SizeOfBuffer The size, in bytes, of Buffer.
@param[in] Buffer A pointer to the buffer to set.
@return Return the pinter to the buffer been set.
@return Return the pointer to the buffer that was set.
**/
VOID *
@@ -1338,7 +1338,7 @@ LibPcdSetExPtr (
@param[in] TokenNumber The PCD token number to set a current value for.
@param[in] Value The Boolean value to set.
@return Return the value been set.
@return Return the value that was set.
**/
BOOLEAN
@@ -1353,9 +1353,9 @@ LibPcdSetExBool (
/**
This notification function serves two purposes.
Firstly, it notifies the module which did the registration that the value of this
Firstly, it notifies the module that did the registration that the value of this
PCD token has been set.
Secondly, it provides a mechanism for the module which did the registration to intercept
Secondly, it provides a mechanism for the module that did the registration to intercept
the set operation and override the value been set if necessary. After the invocation of
the callback function, TokenData will be used by PCD service PEIM or driver to modify th
internal data in PCD database.
@@ -1491,7 +1491,7 @@ LibPcdGetNextTokenSpace (
@param[in, out] SizeOfBuffer A pointer to the size, in bytes, of Buffer.
@param[in] Buffer A pointer to the buffer to used to set the target variable.
@return Return the pointer to the buffer been set.
@return Return the pointer to the buffer that was set.
**/
VOID *