Add in function description and comments.

[mirror_edk2.git] / EdkModulePkg / Universal / PCD / Pei / Service.c

diff --git a/EdkModulePkg/Universal/PCD/Pei/Service.c b/EdkModulePkg/Universal/PCD/Pei/Service.c
index 7b13dc2fa063f47f070708b1908086ae5802bc04..255267c9abe1432fa4adc7958b9753c221348c88 100644 (file)
--- a/EdkModulePkg/Universal/PCD/Pei/Service.c
+++ b/EdkModulePkg/Universal/PCD/Pei/Service.c
@@ -20,12 +20,15 @@ Module Name: Service.c
   The function registers the CallBackOnSet fucntion\r
   according to TokenNumber and EFI_GUID space.\r
 \r
-  @param[in]  TokenNumber       The token number.\r
-  @param[in]  Guid              The GUID space.\r
-  @param[in]  CallBackFunction  The Callback function to be registered.\r
+  @param  TokenNumber       The token number.\r
+  @param  Guid              The GUID space.\r
+  @param  CallBackFunction  The Callback function to be registered.\r
+  @param  Register          To register or unregister the callback function.\r
 \r
   @retval EFI_SUCCESS If the Callback function is registered.\r
   @retval EFI_NOT_FOUND If the PCD Entry is not found according to Token Number and GUID space.\r
+  @retval EFI_OUT_OF_RESOURCES If the callback function can't be registered because there is not free\r
+                                slot left in the CallbackFnTable.\r
 --*/\r
 EFI_STATUS\r
 PeiRegisterCallBackWorker (\r
@@ -103,10 +106,9 @@ PeiRegisterCallBackWorker (
 \r
 \r
 /**\r
-  The function builds the PCD database based on the\r
-  PCD_IMAGE on the flash.\r
+  The function builds the PCD database.\r
 \r
-  @param[in] PcdImageOnFlash  The PCD image on flash.\r
+  @param VOID\r
 \r
   @retval VOID\r
 --*/\r
@@ -144,13 +146,13 @@ BuildPcdDatabase (
   The function is provided by PCD PEIM and PCD DXE driver to\r
   do the work of reading a HII variable from variable service.\r
 \r
-  @param[in] VariableGuid     The Variable GUID.\r
-  @param[in] VariableName     The Variable Name.\r
-  @param[out] VariableData    The output data.\r
-  @param[out] VariableSize    The size of the variable.\r
+  @param VariableGuid     The Variable GUID.\r
+  @param VariableName     The Variable Name.\r
+  @param VariableData    The output data.\r
+  @param VariableSize    The size of the variable.\r
 \r
   @retval EFI_SUCCESS         Operation successful.\r
-  @retval EFI_SUCCESS         Variablel not found.\r
+  @retval EFI_NOT_FOUND         Variablel not found.\r
 --*/\r
 EFI_STATUS\r
 GetHiiVariable (\r
@@ -580,6 +582,7 @@ GetWorker (
 }\r
 \r
 \r
+\r
 UINTN           \r
 GetExPcdTokenNumber (\r
   IN CONST EFI_GUID             *Guid,\r
@@ -635,6 +638,7 @@ GetPcdDatabase (
 }\r
 \r
 \r
+\r
 SKU_ID *\r
 GetSkuIdArray (\r
   IN    UINTN             LocalTokenNumberTableIdx,\r