Comments synchronized with library class

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

diff --git a/MdePkg/Library/DxePcdLib/DxePcdLib.c b/MdePkg/Library/DxePcdLib/DxePcdLib.c
index 370b31b0ef797b8e6add48bd143e246a9c722860..703dd428a0ccfad3eff262e130e306848871f397 100644 (file)
--- a/MdePkg/Library/DxePcdLib/DxePcdLib.c
+++ b/MdePkg/Library/DxePcdLib/DxePcdLib.c
@@ -60,13 +60,12 @@ PcdLibConstructor (
   This function provides a means by which SKU support can be established in the PCD infrastructure.\r
 \r
   Sets the current SKU in the PCD database to the value specified by SkuId.  SkuId is returned.\r
+  If SkuId >= PCD_MAX_SKU_ID, then ASSERT(). \r
 \r
-  @param[in]  SkuId The SKU value that will be used when the PCD service will retrieve and \r
-                    set values associated with a PCD token.\r
-                    \r
-  If SkuId >= 0x100, then ASSERT().                  \r
+  @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 just be set.\r
 \r
 **/\r
 UINTN\r
@@ -236,9 +235,9 @@ LibPcdGetSize (
   \r
   If Guid is NULL, then ASSERT(). \r
 \r
-  @param[in]  Guid Pointer to a 128-bit unique value that designates \r
-              which namespace to retrieve a value from.\r
-  @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
+  @param[in]  Guid         Pointer to a 128-bit unique value that designates \r
+                           which namespace to retrieve a value from.\r
+  @param[in]  TokenNumber  The PCD token number to retrieve a current value for.\r
 \r
   @return Return the UINT8.\r
 \r
@@ -263,9 +262,9 @@ LibPcdGetEx8 (
   \r
   If Guid is NULL, then ASSERT(). \r
 \r
-  @param[in]  Guid Pointer to a 128-bit unique value that designates \r
-              which namespace to retrieve a value from.\r
-  @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
+  @param[in]  Guid         Pointer to a 128-bit unique value that designates \r
+                           which namespace to retrieve a value from.\r
+  @param[in]  TokenNumber  The PCD token number to retrieve a current value for.\r
 \r
   @return Return the UINT16.\r
 \r
@@ -287,9 +286,9 @@ LibPcdGetEx16 (
   Returns the 32-bit value for the token specified by TokenNumber and Guid.\r
   If Guid is NULL, then ASSERT(). \r
 \r
-  @param[in]  Guid Pointer to a 128-bit unique value that designates \r
-              which namespace to retrieve a value from.\r
-  @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
+  @param[in]  Guid         Pointer to a 128-bit unique value that designates \r
+                           which namespace to retrieve a value from.\r
+  @param[in]  TokenNumber  The PCD token number to retrieve a current value for.\r
 \r
   @return Return the UINT32.\r
 \r
@@ -859,14 +858,13 @@ LibPcdSetExBool (
   \r
   When the token specified by TokenNumber and Guid is set, \r
   then notification function specified by NotificationFunction is called.  \r
-  If Guid is NULL, then the default token space is used. \r
-  \r
+  If Guid is NULL, then the default token space is used.\r
   If NotificationFunction is NULL, then ASSERT().\r
 \r
-  @param[in]  Guid      Pointer to a 128-bit unique value that designates which \r
-                        namespace to set a value from.  If NULL, then the default \r
-                        token space is used.\r
-  @param[in]  TokenNumber   The PCD token number to monitor.\r
+  @param[in]  Guid                  Pointer to a 128-bit unique value that designates which \r
+                                    namespace to set a value from.  If NULL, then the default \r
+                                    token space is used.\r
+  @param[in]  TokenNumber           The PCD token number to monitor.\r
   @param[in]  NotificationFunction  The function to call when the token \r
                                     specified by Guid and TokenNumber is set.\r
 \r
@@ -895,14 +893,13 @@ LibPcdCallbackOnSet (
 /**\r
   Disable a notification function that was established with LibPcdCallbackonSet().\r
   \r
-  Disable a notification function that was previously established with LibPcdCallbackOnSet(). \r
-  \r
+  Disable a notification function that was previously established with LibPcdCallbackOnSet().\r
   If NotificationFunction is NULL, then ASSERT().\r
   If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber, \r
   and NotificationFunction, then ASSERT().\r
   \r
-  @param[in]  Guid          Specify the GUID token space.\r
-  @param[in]  TokenNumber   Specify the token number.\r
+  @param[in]  Guid                 Specify the GUID token space.\r
+  @param[in]  TokenNumber          Specify the token number.\r
   @param[in]  NotificationFunction The callback function to be unregistered.\r
 \r
 **/\r
@@ -967,23 +964,17 @@ LibPcdGetNextToken (
 /**\r
   Used to retrieve the list of available PCD token space GUIDs.\r
   \r
-  Retrieves the next PCD token space from a token space specified by Guid.\r
-  Guid of NULL is reserved to mark the default local token namespace on the current\r
-  platform. If Guid is NULL, then the GUID of the first non-local token space of the \r
-  current platform is returned. If Guid is the last non-local token space, \r
-  then NULL is returned. \r
-\r
-  If Guid is not NULL and is not a valid token space in the current platform, then ASSERT().\r
-\r
-\r
+  Returns the PCD token space GUID that follows TokenSpaceGuid in the list of token spaces\r
+  in the platform.\r
+  If TokenSpaceGuid is NULL, then a pointer to the first PCD token spaces returned.\r
+  If TokenSpaceGuid is the last PCD token space GUID in the list, then NULL is returned.\r
   \r
-  @param[in]  Guid  Pointer to a 128-bit unique value that designates from which namespace \r
-                    to start the search.\r
+  @param  TokenSpaceGuid  Pointer to the a PCD token space GUID\r
 \r
   @return The next valid token namespace.\r
 \r
 **/\r
-GUID *           \r
+GUID *\r
 EFIAPI\r
 LibPcdGetNextTokenSpace (\r
   IN CONST GUID  *TokenSpaceGuid\r

diff --git a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c
index 9a5587521c4e2fc77806f2371f53b62c0c9d97a9..2e2dbb6ac51c59603c0926a3696a4f0b819d3730 100644 (file)
--- a/MdePkg/Library/PeiPcdLib/PeiPcdLib.c
+++ b/MdePkg/Library/PeiPcdLib/PeiPcdLib.c
@@ -52,13 +52,12 @@ GetPcdPpiPointer (
   This function provides a means by which SKU support can be established in the PCD infrastructure.\r
 \r
   Sets the current SKU in the PCD database to the value specified by SkuId.  SkuId is returned.\r
+  If SkuId >= PCD_MAX_SKU_ID, then ASSERT(). \r
 \r
-  @param[in]  SkuId The SKU value that will be used when the PCD service will retrieve and \r
-                    set values associated with a PCD token.\r
-                    \r
-  If SkuId >= 0x100, then ASSERT().                  \r
+  @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 just be set.\r
 \r
 **/\r
 UINTN\r
@@ -229,9 +228,9 @@ LibPcdGetSize (
   \r
   If Guid is NULL, then ASSERT(). \r
 \r
-  @param[in]  Guid Pointer to a 128-bit unique value that designates \r
-              which namespace to retrieve a value from.\r
-  @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
+  @param[in]  Guid         Pointer to a 128-bit unique value that designates \r
+                           which namespace to retrieve a value from.\r
+  @param[in]  TokenNumber  The PCD token number to retrieve a current value for.\r
 \r
   @return Return the UINT8.\r
 \r
@@ -257,9 +256,9 @@ LibPcdGetEx8 (
   \r
   If Guid is NULL, then ASSERT(). \r
 \r
-  @param[in]  Guid Pointer to a 128-bit unique value that designates \r
-              which namespace to retrieve a value from.\r
-  @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
+  @param[in]  Guid         Pointer to a 128-bit unique value that designates \r
+                           which namespace to retrieve a value from.\r
+  @param[in]  TokenNumber  The PCD token number to retrieve a current value for.\r
 \r
   @return Return the UINT16.\r
 \r
@@ -283,9 +282,9 @@ LibPcdGetEx16 (
   Returns the 32-bit value for the token specified by TokenNumber and Guid.\r
   If Guid is NULL, then ASSERT(). \r
 \r
-  @param[in]  Guid Pointer to a 128-bit unique value that designates \r
-              which namespace to retrieve a value from.\r
-  @param[in]  TokenNumber The PCD token number to retrieve a current value for.\r
+  @param[in]  Guid         Pointer to a 128-bit unique value that designates \r
+                           which namespace to retrieve a value from.\r
+  @param[in]  TokenNumber  The PCD token number to retrieve a current value for.\r
 \r
   @return Return the UINT32.\r
 \r
@@ -847,14 +846,13 @@ LibPcdSetExBool (
   \r
   When the token specified by TokenNumber and Guid is set, \r
   then notification function specified by NotificationFunction is called.  \r
-  If Guid is NULL, then the default token space is used. \r
-  \r
+  If Guid is NULL, then the default token space is used.\r
   If NotificationFunction is NULL, then ASSERT().\r
 \r
-  @param[in]  Guid      Pointer to a 128-bit unique value that designates which \r
-                        namespace to set a value from.  If NULL, then the default \r
-                        token space is used.\r
-  @param[in]  TokenNumber   The PCD token number to monitor.\r
+  @param[in]  Guid                  Pointer to a 128-bit unique value that designates which \r
+                                    namespace to set a value from.  If NULL, then the default \r
+                                    token space is used.\r
+  @param[in]  TokenNumber           The PCD token number to monitor.\r
   @param[in]  NotificationFunction  The function to call when the token \r
                                     specified by Guid and TokenNumber is set.\r
 \r
@@ -883,14 +881,13 @@ LibPcdCallbackOnSet (
 /**\r
   Disable a notification function that was established with LibPcdCallbackonSet().\r
   \r
-  Disable a notification function that was previously established with LibPcdCallbackOnSet(). \r
-  \r
+  Disable a notification function that was previously established with LibPcdCallbackOnSet().\r
   If NotificationFunction is NULL, then ASSERT().\r
   If LibPcdCallbackOnSet() was not previously called with Guid, TokenNumber, \r
   and NotificationFunction, then ASSERT().\r
   \r
-  @param[in]  Guid          Specify the GUID token space.\r
-  @param[in]  TokenNumber   Specify the token number.\r
+  @param[in]  Guid                 Specify the GUID token space.\r
+  @param[in]  TokenNumber          Specify the token number.\r
   @param[in]  NotificationFunction The callback function to be unregistered.\r
 \r
 **/\r
@@ -964,7 +961,7 @@ LibPcdGetNextToken (
   @return The next valid token namespace.\r
 \r
 **/\r
-GUID *           \r
+GUID *\r
 EFIAPI\r
 LibPcdGetNextTokenSpace (\r
   IN CONST GUID  *TokenSpaceGuid\r