Add doxygen style comments for functions in DxeIpl.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5174 6f19259b-4bc3-4df7-8a09-765794883524
2008-05-07 06:58:06 +00:00
parent 6d3f77236c
commit 91d92e2564
10 changed files with 383 additions and 105 deletions
--- a/MdeModulePkg/Core/DxeIplPeim/Ia32/DxeLoadFunc.c
+++ b/MdeModulePkg/Core/DxeIplPeim/Ia32/DxeLoadFunc.c
@@ -44,6 +44,22 @@ GLOBAL_REMOVE_IF_UNREFERENCED  IA32_DESCRIPTOR gLidtDescriptor = {
  0
 };

+
+
+
+
+/**
+   Transfers control to DxeCore.
+
+   This function performs a CPU architecture specific operations to execute
+   the entry point of DxeCore with the parameters of HobList.
+   It also intalls EFI_END_OF_PEI_PPI to signal the end of PEI phase.
+
+   @param DxeCoreEntryPoint         The entrypoint of DxeCore.
+   @param HobList                   The start of HobList passed to DxeCore.
+   @param EndOfPeiSignal            The PPI descriptor for EFI_END_OF_PEI_PPI.
+
+**/
 VOID
 HandOffToDxeCore (
  IN EFI_PHYSICAL_ADDRESS   DxeCoreEntryPoint,