Add doxygen style comments for functions in DxeIpl.

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

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