Comments have been synchronized with spec.

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

diff --git a/MdePkg/Include/Library/DxeCoreEntryPoint.h b/MdePkg/Include/Library/DxeCoreEntryPoint.h
index f2454ef0986dad2011df30e943587e0a1f10b01e..04f2dbf55e4f5ecae4eb079058d2fc509f99da50 100644 (file)
--- a/MdePkg/Include/Library/DxeCoreEntryPoint.h
+++ b/MdePkg/Include/Library/DxeCoreEntryPoint.h
@@ -22,9 +22,16 @@ extern VOID  *gHobList;
 \r
 \r
 /**\r
-  Enrty point to DXE core.\r
+  The entry point of PE/COFF Image for the DXE Core. \r
 \r
-  @param  HobStart Pointer of HobList.\r
+  This function is the entry point for the DXE Core.  This function is required\r
+  to call ProcessModuleEntryPointList() and ProcessModuleEntryPoint() is never\r
+  expected to return.  The DXE Core is responsible for calling ProcessLibraryConstructorList()\r
+  as soon as the EFI System Table and the image handle for the DXE Core itself have\r
+  been established.\r
+  If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.\r
+\r
+  @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase. \r
 \r
 **/\r
 VOID\r
@@ -35,9 +42,11 @@ _ModuleEntryPoint (
 \r
 \r
 /**\r
-  Wrapper of enrty point to DXE CORE.\r
+  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().\r
+\r
+  This function is required to call _ModuleEntryPoint() passing in HobStart.\r
 \r
-  @param  HobStart Pointer of HobList.\r
+  @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase. \r
 \r
 **/\r
 VOID\r
@@ -48,10 +57,19 @@ EfiMain (
 \r
 \r
 /**\r
-  Call constructs for all libraries. Automatics Generated by tool.\r
+  Autogenerated function that calls the library constructors for all of the module's dependent libraries.\r
 \r
-  @param  ImageHandle ImageHandle of the loaded driver.\r
-  @param  SystemTable Pointer to the EFI System Table.\r
+  This function must be called by _ModuleEntryPoint().\r
+  This function calls the set of library constructors for the set of library instances\r
+  that a module depends on.  This includes library instances that a module depends on\r
+  directly and library instances that a module depends on indirectly through other\r
+  libraries. This function is autogenerated by build tools and those build tools are\r
+  responsible for collecting the set of library instances, determine which ones have\r
+  constructors, and calling the library constructors in the proper order based upon\r
+  each of the library instances own dependencies.\r
+\r
+  @param  ImageHandle  The image handle of the DXE Core.\r
+  @param  SystemTable  A pointer to the EFI System Table.\r
 \r
 **/\r
 VOID\r
@@ -76,9 +94,14 @@ ProcessLibraryDestructorList (
   );\r
 \r
 /**\r
-  Call the list of driver entry points. Automatics Generated by tool.\r
+  Autogenerated function that calls a set of module entry points.\r
+\r
+  This function must be called by _ModuleEntryPoint().\r
+  This function calls the set of module entry points.  \r
+  This function is autogenerated by build tools and those build tools are responsible\r
+  for collecting the module entry points and calling them in a specified order.\r
 \r
-  @param  HobStart Pointer to HobList.\r
+  @param  HobStart  Pointer to the beginning of the HOB List passed in from the PEI Phase. \r
  \r
 **/\r
 VOID\r