Synchronize interface function comment from declaration in library class header file to implementation in library instance.

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

MdePkg/Library/PeiServicesLib/PeiServicesLib.c

@@ -466,8 +466,7 @@ PeiServicesFfsGetFileInfo (
   @param VolumeHandle   The firmware volume to search FileHandle
                         Upon exit, points to the found file's
                         handle or NULL if it could not be found.
-
+  @param FileHandle     Pointer to found file handle 
-  @param FileHandle     The filehandle found in volume.
 
   @retval EFI_SUCCESS             File was found.
 

MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c

@@ -22,9 +22,10 @@
 CONST EFI_PEI_SERVICES  **gPeiServices;
 
 /**
-  The function cache the pointer of PEI services to global variable.
+  The function set the pointer of PEI services immediately preceding the IDT table
+  according to PI specification.
   
-  @param    PeiServices   The address of PeiServices pointer.
+  @param    PeiServicesTablePointer   The address of PeiServices pointer.
 **/
 VOID
 EFIAPI

MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c

@@ -22,16 +22,12 @@
 #include <Library/DebugLib.h>
 
 /**
+  The function returns the pointer to PEI services.
 
-  The function returns the pointer to PeiServicee following
+  The function returns the pointer to PEI services.
-  PI1.0.
+  It will ASSERT() if the pointer to PEI services is NULL.
 
-  For IA32, the four-bytes field immediately prior to new IDT
+  @retval  The pointer to PeiServices.
-  base addres is used to save the EFI_PEI_SERVICES**.
-  For x64, the eight-bytes field immediately prior to new IDT
-  base addres is used to save the EFI_PEI_SERVICES**
-  
-  @return  The pointer to PeiServices.
 
 **/
 CONST EFI_PEI_SERVICES **
@@ -50,17 +46,10 @@ GetPeiServicesTablePointer (
 }
 
 /**
+  The function set the pointer of PEI services immediately preceding the IDT table
+  according to PI specification.
   
-  The function sets the pointer to PeiServicee following
+  @param    PeiServicesTablePointer   The address of PeiServices pointer.
-  PI1.0.
-  
-  For IA32, the four-bytes field immediately prior to new IDT
-  base addres is used to save the EFI_PEI_SERVICES**.
-  For x64, the eight-bytes field immediately prior to new IDT
-  base addres is used to save the EFI_PEI_SERVICES**
-  
-  @param PeiServicesTablePointer  The pointer to PeiServices.
-
 **/
 VOID
 EFIAPI

MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c

@@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
   This internal function retrieves Smbus PPI from PPI database.
 
-  @param  PeiServices   An indirect pointer to the EFI_PEI_SERVICES published by the PEI Foundation.
+  @param  VOID
 
   @return The pointer to Smbus PPI.
 
@@ -57,7 +57,7 @@ InternalGetSmbusPpi (
   @param  Status          Return status for the executed command.
                           This is an optional parameter and may be NULL.
 
-  @return The actual number of bytes that are executed for this operation..
+  @return The actual number of bytes that are executed for this operation.
 
 **/
 UINTN

MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c

@@ -26,8 +26,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
                       Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().
   @param  PeiServices Describes the list of possible PEI Services.
 
-  @return  Status returned by entry points of Peims.
+  @retval  EFI_SUCCESS   The PEIM executed normally.
-
+  @retval  !EFI_SUCCESS  The PEIM failed to execute normally.
 **/
 EFI_STATUS
 EFIAPI
@@ -56,13 +56,14 @@ _ModuleEntryPoint (
 
 
 /**
-  Wrapper of Peim image entry point.
+  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().
 
   @param  FileHandle  Handle of the file being invoked. 
                       Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().
   @param  PeiServices Describes the list of possible PEI Services.
 
-  @return  Status returned by entry points of Peims.
+  @retval EFI_SUCCESS  The PEIM executed normally.
+  @retval !EFI_SUCCESS The PEIM failed to execute normally.
 
 **/
 EFI_STATUS