]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Library/DxeCoreEntryPoint/DxeCoreEntryPoint.c
Minor grammatical work--mostly adding periods. Items with ONLY period added did...
[mirror_edk2.git] / MdePkg / Library / DxeCoreEntryPoint / DxeCoreEntryPoint.c
index 489f315efa596c3b94107ae3918f89b5d4574775..d3d8c4c47c51a3e6b172d85caf68f9b3c81d8a1b 100644 (file)
@@ -1,11 +1,11 @@
 /** @file\r
   Entry point to the DXE Core.\r
 \r
-Copyright (c) 2006, Intel Corporation<BR>\r
-All rights reserved. This program and the accompanying materials\r
+Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
+http://opensource.org/licenses/bsd-license.php.\r
 \r
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
@@ -26,9 +26,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 VOID *gHobList = NULL;\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 to call\r
+  ProcessModuleEntryPointList() and ProcessModuleEntryPointList() is never expected to return.\r
+  The DXE Core is responsible for calling ProcessLibraryConstructorList() as soon as the EFI\r
+  System Table and the image handle for the DXE Core itself have been established.\r
+  If ProcessModuleEntryPointList() returns, then ASSERT() and halt the system.\r
+\r
+  @param  HobStart  The pointer to the beginning of the HOB List passed in from the PEI Phase. \r
 \r
 **/\r
 VOID\r
@@ -56,9 +62,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  The pointer to the beginning of the HOB List passed in from the PEI Phase. \r
 \r
 **/\r
 VOID\r