Comments have been synchronized with spec.

[mirror_edk2.git] / MdePkg / Include / Library / PeimEntryPoint.h

diff --git a/MdePkg/Include/Library/PeimEntryPoint.h b/MdePkg/Include/Library/PeimEntryPoint.h
index 9980c91d0efa931ddfa1603f87763d8b67038df6..ae53b2f94d2f18d03d16f29fde1b400955e03533 100644 (file)
--- a/MdePkg/Include/Library/PeimEntryPoint.h
+++ b/MdePkg/Include/Library/PeimEntryPoint.h
@@ -28,8 +28,8 @@ extern CONST UINT32       _gPeimRevision;
                       Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().\r
   @param  PeiServices Describes the list of possible PEI Services.\r
 \r
-  @return  Status returned by entry points of Peims.\r
-\r
+  @retval  EFI_SUCCESS   The PEIM executed normally.\r
+  @retval  !EFI_SUCCESS  The PEIM failed to execute normally.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
@@ -40,13 +40,14 @@ _ModuleEntryPoint (
 \r
 \r
 /**\r
-  Wrapper of Peim image entry point.\r
+  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().\r
 \r
   @param  FileHandle  Handle of the file being invoked. \r
                       Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().\r
   @param  PeiServices Describes the list of possible PEI Services.\r
 \r
-  @return  Status returned by entry points of Peims.\r
+  @retval EFI_SUCCESS  The PEIM executed normally.\r
+  @retval !EFI_SUCCESS The PEIM failed to execute normally.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -96,7 +97,8 @@ ProcessLibraryDestructorList (
                       Type EFI_PEI_FILE_HANDLE is defined in FfsFindNextFile().\r
   @param  PeiServices Describes the list of possible PEI Services.\r
 \r
-  @return Status returned by entry points of drivers.  \r
+  @retval EFI_SUCCESS  The PEIM executed normally.\r
+  @retval !EFI_SUCCESS The PEIM failed to execute normally.\r
  \r
 **/\r
 EFI_STATUS\r