Comments synchronized with library class

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7525 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
jji4 2009-02-13 09:05:43 +00:00
parent b677694d2e
commit c00bdbb14a
2 changed files with 49 additions and 61 deletions

View File

@ -60,11 +60,10 @@ PcdLibConstructor (
This function provides a means by which SKU support can be established in the PCD infrastructure.
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.
If SkuId >= PCD_MAX_SKU_ID, then ASSERT().
@param[in] SkuId The SKU value that will be used when the PCD service will retrieve and
set values associated with a PCD token.
If SkuId >= 0x100, then ASSERT().
@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.
@ -860,7 +859,6 @@ LibPcdSetExBool (
When the token specified by TokenNumber and Guid is set,
then notification function specified by NotificationFunction is called.
If Guid is NULL, then the default token space is used.
If NotificationFunction is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates which
@ -896,7 +894,6 @@ LibPcdCallbackOnSet (
Disable a notification function that was established with LibPcdCallbackonSet().
Disable a notification function that was previously established with LibPcdCallbackOnSet().
If NotificationFunction is NULL, then ASSERT().
If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber,
and NotificationFunction, then ASSERT().
@ -967,18 +964,12 @@ LibPcdGetNextToken (
/**
Used to retrieve the list of available PCD token space GUIDs.
Retrieves the next PCD token space from a token space specified by Guid.
Guid of NULL is reserved to mark the default local token namespace on the current
platform. If Guid is NULL, then the GUID of the first non-local token space of the
current platform is returned. If Guid is the last non-local token space,
then NULL is returned.
Returns the PCD token space GUID that follows TokenSpaceGuid in the list of token spaces
in the platform.
If TokenSpaceGuid is NULL, then a pointer to the first PCD token spaces returned.
If TokenSpaceGuid is the last PCD token space GUID in the list, then NULL is returned.
If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates from which namespace
to start the search.
@param TokenSpaceGuid Pointer to the a PCD token space GUID
@return The next valid token namespace.

View File

@ -52,11 +52,10 @@ GetPcdPpiPointer (
This function provides a means by which SKU support can be established in the PCD infrastructure.
Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.
If SkuId >= PCD_MAX_SKU_ID, then ASSERT().
@param[in] SkuId The SKU value that will be used when the PCD service will retrieve and
set values associated with a PCD token.
If SkuId >= 0x100, then ASSERT().
@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.
@ -848,7 +847,6 @@ LibPcdSetExBool (
When the token specified by TokenNumber and Guid is set,
then notification function specified by NotificationFunction is called.
If Guid is NULL, then the default token space is used.
If NotificationFunction is NULL, then ASSERT().
@param[in] Guid Pointer to a 128-bit unique value that designates which
@ -884,7 +882,6 @@ LibPcdCallbackOnSet (
Disable a notification function that was established with LibPcdCallbackonSet().
Disable a notification function that was previously established with LibPcdCallbackOnSet().
If NotificationFunction is NULL, then ASSERT().
If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber,
and NotificationFunction, then ASSERT().