From 91d92e25647e9a26392b454499d309330710a076 Mon Sep 17 00:00:00 2001
From: qhuang8 <qhuang8@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Wed, 7 May 2008 06:58:06 +0000
Subject: 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
---
 MdeModulePkg/Core/DxeIplPeim/Ipf/DxeLoadFunc.c | 14 ++++++++
 MdeModulePkg/Core/DxeIplPeim/Ipf/ImageRead.c   | 47 ++++++++++++++------------
 2 files changed, 40 insertions(+), 21 deletions(-)

(limited to 'MdeModulePkg/Core/DxeIplPeim/Ipf')

diff --git a/MdeModulePkg/Core/DxeIplPeim/Ipf/DxeLoadFunc.c b/MdeModulePkg/Core/DxeIplPeim/Ipf/DxeLoadFunc.c
index b27521d896..c31cba8dcf 100644
--- 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.
 
 #include "DxeIpl.h"
 
+
+
+/**
+   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,
diff --git a/MdeModulePkg/Core/DxeIplPeim/Ipf/ImageRead.c b/MdeModulePkg/Core/DxeIplPeim/Ipf/ImageRead.c
index f449ecad9a..fd827248a1 100644
--- a/MdeModulePkg/Core/DxeIplPeim/Ipf/ImageRead.c
+++ b/MdeModulePkg/Core/DxeIplPeim/Ipf/ImageRead.c
@@ -14,6 +14,21 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 
 #include "DxeIpl.h"
 
+
+
+/**
+  Support routine for the PE/COFF Loader that reads a buffer from a PE/COFF file
+
+  @param  FileHandle   The handle to the PE/COFF file 
+  @param  FileOffset   The offset, in bytes, into the file to read 
+  @param  ReadSize     The number of bytes to read from the file starting at 
+                       FileOffset 
+  @param  Buffer       A pointer to the buffer to read the data into. 
+
+  @retval EFI_SUCCESS  ReadSize bytes of data were read into Buffer from the 
+                       PE/COFF file starting at FileOffset
+
+**/
 EFI_STATUS
 PeiImageRead (
   IN     VOID    *FileHandle,
@@ -21,27 +36,6 @@ PeiImageRead (
   IN OUT UINTN   *ReadSize,
   OUT    VOID    *Buffer
   )
-/*++
-
-Routine Description:
-
-  Support routine for the PE/COFF Loader that reads a buffer from a PE/COFF file
-
-Arguments:
-
-  FileHandle - The handle to the PE/COFF file
-
-  FileOffset - The offset, in bytes, into the file to read
-
-  ReadSize   - The number of bytes to read from the file starting at FileOffset
-
-  Buffer     - A pointer to the buffer to read the data into.
-
-Returns:
-
-  EFI_SUCCESS - ReadSize bytes of data were read into Buffer from the PE/COFF file starting at FileOffset
-
---*/
 {
   CHAR8 *Destination8;
   CHAR8 *Source8;
@@ -55,6 +49,17 @@ Returns:
   return EFI_SUCCESS;
 }
 
+
+/**
+   This function simply retrieves the function pointer of ImageRead in
+   ImageContext structure.
+    
+   @param ImageContext       A pointer to the structure of 
+                             PE_COFF_LOADER_IMAGE_CONTEXT
+   
+   @retval EFI_SUCCESS       This function always return EFI_SUCCESS.
+
+**/
 EFI_STATUS
 GetImageReadFunction (
   IN      PE_COFF_LOADER_IMAGE_CONTEXT  *ImageContext
-- 
cgit v1.2.3