summaryrefslogtreecommitdiffstats
path: root/MdePkg/Library/PeimEntryPoint
diff options
context:
space:
mode:
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2008-12-10 03:10:07 +0000
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2008-12-10 03:10:07 +0000
commitf38fdc749879ff6b9339fded2062e3dac46fa72d (patch)
treee289ee2ab60215685af2daa102681f68f2936e5b /MdePkg/Library/PeimEntryPoint
parent753f9e6948b189c19f3801793d3be1b1687b319b (diff)
downloadedk2-f38fdc749879ff6b9339fded2062e3dac46fa72d.tar.gz
edk2-f38fdc749879ff6b9339fded2062e3dac46fa72d.tar.bz2
edk2-f38fdc749879ff6b9339fded2062e3dac46fa72d.zip
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
Diffstat (limited to 'MdePkg/Library/PeimEntryPoint')
-rw-r--r--MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c13
1 files changed, 7 insertions, 6 deletions
diff --git a/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c b/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c
index 286c2df9e8..a03c377059 100644
--- a/MdePkg/Library/PeimEntryPoint/PeimEntryPoint.c
+++ b/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,20 +56,21 @@ _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
EFIAPI
EfiMain (
- IN EFI_PEI_FILE_HANDLE FileHandle,
- IN CONST EFI_PEI_SERVICES **PeiServices
+ IN EFI_PEI_FILE_HANDLE FileHandle,
+ IN CONST EFI_PEI_SERVICES **PeiServices
)
{
return _ModuleEntryPoint (FileHandle, PeiServices);