Add doxygen style comments for functions in DxeIpl.

[mirror_edk2.git] / MdeModulePkg / Core / DxeIplPeim / Ipf / DxeLoadFunc.c

diff --git a/MdeModulePkg/Core/DxeIplPeim/Ipf/DxeLoadFunc.c b/MdeModulePkg/Core/DxeIplPeim/Ipf/DxeLoadFunc.c
index b27521d896a3b7f7dc60ad04600d0439bdf26781..c31cba8dcf1f9150267c33ada8aba64e78afdb3e 100644 (file)
--- a/MdeModulePkg/Core/DxeIplPeim/Ipf/DxeLoadFunc.c
+++ b/MdeModulePkg/Core/DxeIplPeim/Ipf/DxeLoadFunc.c
@@ -14,6 +14,20 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "DxeIpl.h"\r
 \r
+\r
+\r
+/**\r
+   Transfers control to DxeCore.\r
+\r
+   This function performs a CPU architecture specific operations to execute\r
+   the entry point of DxeCore with the parameters of HobList.\r
+   It also intalls EFI_END_OF_PEI_PPI to signal the end of PEI phase.\r
+\r
+   @param DxeCoreEntryPoint         The entrypoint of DxeCore.\r
+   @param HobList                   The start of HobList passed to DxeCore.\r
+   @param EndOfPeiSignal            The PPI descriptor for EFI_END_OF_PEI_PPI.\r
+\r
+**/\r
 VOID\r
 HandOffToDxeCore (\r
   IN EFI_PHYSICAL_ADDRESS   DxeCoreEntryPoint,\r