correct comments

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

diff --git a/MdeModulePkg/Core/Pei/Ppi/Ppi.c b/MdeModulePkg/Core/Pei/Ppi/Ppi.c
index 28ddd99e3ce2db8824dc6231cf460e8387cb5d3c..0649859f3ed3d0d47684caeb4c9c0337aed6829d 100644 (file)
--- a/MdeModulePkg/Core/Pei/Ppi/Ppi.c
+++ b/MdeModulePkg/Core/Pei/Ppi/Ppi.c
@@ -40,7 +40,7 @@ InitializePpiServices (
 \r
   Migrate the Hob list from the CAR stack to PEI installed memory.\r
 \r
-  @param PeiServices         The PEI core services table.\r
+  @param PrivateData         Pointer to PeiCore's private data structure.\r
   @param OldCheckingBottom   The old checking bottom.\r
   @param OldCheckingTop      The old checking top.\r
   @param Fixup               The address difference between\r
@@ -105,15 +105,17 @@ ConvertPpiPointers (
 \r
 /**\r
 \r
-  Install PPI services.\r
+  This function installs an interface in the PEI PPI database by GUID. \r
+  The purpose of the service is to publish an interface that other parties\r
+  can use to call additional PEIMs.\r
 \r
-  @param PeiServices     - Pointer to the PEI Service Table\r
-  @param PpiList         - Pointer to a list of PEI PPI Descriptors.\r
+  @param PeiServices                An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param PpiList                    Pointer to a list of PEI PPI Descriptors.\r
 \r
-  @retval EFI_SUCCESS             - if all PPIs in PpiList are successfully installed.\r
-  @retval EFI_INVALID_PARAMETER   - if PpiList is NULL pointer\r
-  @retval EFI_INVALID_PARAMETER   - if any PPI in PpiList is not valid\r
-  @retval EFI_OUT_OF_RESOURCES    - if there is no more memory resource to install PPI\r
+  @retval EFI_SUCCESS              if all PPIs in PpiList are successfully installed.\r
+  @retval EFI_INVALID_PARAMETER    if PpiList is NULL pointer\r
+  @retval EFI_INVALID_PARAMETER    if any PPI in PpiList is not valid\r
+  @retval EFI_OUT_OF_RESOURCES     if there is no more memory resource to install PPI\r
 \r
 **/\r
 EFI_STATUS\r
@@ -195,16 +197,19 @@ PeiInstallPpi (
 \r
 /**\r
 \r
-  Re-Install PPI services.\r
+  This function reinstalls an interface in the PEI PPI database by GUID. \r
+  The purpose of the service is to publish an interface that other parties can \r
+  use to replace an interface of the same name in the protocol database with a \r
+  different interface.\r
 \r
-  @param PeiServices     - Pointer to the PEI Service Table\r
-  @param OldPpi          - Pointer to the old PEI PPI Descriptors.\r
-  @param NewPpi          - Pointer to the new PEI PPI Descriptors.\r
+  @param PeiServices            An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param OldPpi                 Pointer to the old PEI PPI Descriptors.\r
+  @param NewPpi                 Pointer to the new PEI PPI Descriptors.\r
 \r
-  @retval EFI_SUCCESS           - if the operation was successful\r
-  @retval EFI_INVALID_PARAMETER - if OldPpi or NewPpi is NULL\r
-  @retval EFI_INVALID_PARAMETER - if NewPpi is not valid\r
-  @retval EFI_NOT_FOUND         - if the PPI was not in the database\r
+  @retval EFI_SUCCESS           if the operation was successful\r
+  @retval EFI_INVALID_PARAMETER if OldPpi or NewPpi is NULL\r
+  @retval EFI_INVALID_PARAMETER if NewPpi is not valid\r
+  @retval EFI_NOT_FOUND         if the PPI was not in the database\r
 \r
 **/\r
 EFI_STATUS\r
@@ -269,12 +274,12 @@ PeiReInstallPpi (
   Locate a given named PPI.\r
 \r
 \r
-  @param PeiServices     - Pointer to the PEI Service Table\r
-  @param Guid            - Pointer to GUID of the PPI.\r
-  @param Instance        - Instance Number to discover.\r
-  @param PpiDescriptor   - Pointer to reference the found descriptor. If not NULL,\r
-                         returns a pointer to the descriptor (includes flags, etc)\r
-  @param Ppi             - Pointer to reference the found PPI\r
+  @param PeiServices        An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param Guid               Pointer to GUID of the PPI.\r
+  @param Instance           Instance Number to discover.\r
+  @param PpiDescriptor      Pointer to reference the found descriptor. If not NULL,\r
+                            returns a pointer to the descriptor (includes flags, etc)\r
+  @param Ppi                Pointer to reference the found PPI\r
 \r
   @retval EFI_SUCCESS   if the PPI is in the database\r
   @retval EFI_NOT_FOUND if the PPI is not in the database\r
@@ -285,9 +290,9 @@ EFIAPI
 PeiLocatePpi (\r
   IN CONST EFI_PEI_SERVICES        **PeiServices,\r
   IN CONST EFI_GUID                *Guid,\r
-  IN UINTN                   Instance,\r
-  IN OUT EFI_PEI_PPI_DESCRIPTOR  **PpiDescriptor,\r
-  IN OUT VOID                **Ppi\r
+  IN UINTN                         Instance,\r
+  IN OUT EFI_PEI_PPI_DESCRIPTOR    **PpiDescriptor,\r
+  IN OUT VOID                      **Ppi\r
   )\r
 {\r
   PEI_CORE_INSTANCE   *PrivateData;\r
@@ -336,10 +341,12 @@ PeiLocatePpi (
 \r
 /**\r
 \r
-  Install a notification for a given PPI.\r
+  This function installs a notification service to be called back when a given \r
+  interface is installed or reinstalled. The purpose of the service is to publish \r
+  an interface that other parties can use to call additional PPIs that may materialize later.\r
 \r
-  @param PeiServices     - Pointer to the PEI Service Table\r
-  @param NotifyList      - Pointer to list of Descriptors to notify upon.\r
+  @param PeiServices        An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r
+  @param NotifyList         Pointer to list of Descriptors to notify upon.\r
 \r
   @retval EFI_SUCCESS           if successful\r
   @retval EFI_OUT_OF_RESOURCES  if no space in the database\r