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
This commit is contained in:
@@ -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
|
||||
|
Reference in New Issue
Block a user