tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
This commit is contained in:
klu2 2008-12-10 03:10:07 +00:00
parent 753f9e6948
commit f38fdc7498
5 changed files with 25 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
MdePkg/Library/PeiServicesLib/PeiServicesLib.c
View File

@ -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 The filehandle found in volume.
@param FileHandle Pointer to found file handle
@retval EFI_SUCCESS File was found.

5
MdePkg/Library/PeiServicesTablePointerLib/PeiServicesTablePointer.c
View File

@ -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

25
MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c
View File

@ -22,16 +22,12 @@
#include <Library/DebugLib.h>
/**
The function returns the pointer to PEI services.
The function returns the pointer to PeiServicee following
PI1.0.
The function returns the pointer to PEI services.
It will ASSERT() if the pointer to PEI services is NULL.
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**
@return The pointer to PeiServices.
@retval 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
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.
@param PeiServicesTablePointer The address of PeiServices pointer.
**/
VOID
EFIAPI

4
MdePkg/Library/PeiSmbusLibSmbus2Ppi/PeiSmbusLib.c
View File

@ -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

9
MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c
View File

@ -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