sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix doxygen comment for structure and macro

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6096 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2
2008-10-09 19:05:11 +00:00
parent 721b16af11
commit cce6f7aa66
11 changed files with 224 additions and 571 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
MdePkg/Include/Protocol/LoadedImage.h
View File

@@ -48,72 +48,60 @@
/**
@par Protocol Description:
Can be used on any image handle to obtain information about the loaded image.
@param Revision
Defines the revision of the EFI_LOADED_IMAGE_PROTOCOL structure.
All future revisions will be backward compatible to the current revision.
@param ParentHandle
Parent image's image handle. NULL if the image is loaded directly from
the firmware's boot manager.
@param SystemTable
The image's EFI system table pointer.
@param DeviceHandle
The device handle that the EFI Image was loaded from.
@param FilePath
A pointer to the file path portion specific to DeviceHandle
that the EFI Image was loaded from.
@param Reserved
Reserved. DO NOT USE.
@param LoadOptionsSize
The size in bytes of LoadOptions.
@param LoadOptions
A pointer to the image's binary load options.
@param ImageBase
The base address at which the image was loaded.
@param ImageSize
The size in bytes of the loaded image.
@param ImageCodeType
The memory
@param ImageDataType
The memory
@param Unload
Function that unloads the image.
**/
typedef struct {
///
/// Defines the revision of the EFI_LOADED_IMAGE_PROTOCOL structure.
/// All future revisions will be backward compatible to the current revision.
///
UINT32 Revision;
///
/// Parent image's image handle. NULL if the image is loaded directly from
/// the firmware's boot manager.
///
EFI_HANDLE ParentHandle;
EFI_SYSTEM_TABLE *SystemTable;
//
// Source location of image
//
///
/// The device handle that the EFI Image was loaded from.
///
EFI_HANDLE DeviceHandle;
///
/// A pointer to the file path portion specific to DeviceHandle
/// that the EFI Image was loaded from.
///
EFI_DEVICE_PATH_PROTOCOL *FilePath;
VOID *Reserved;
VOID *Reserved; ///< Reserved. DO NOT USE.
//
// Images load options
//
///
/// The size in bytes of LoadOptions.
///
UINT32 LoadOptionsSize;
///
/// A pointer to the image's binary load options.
///
VOID *LoadOptions;
//
// Location of where image was loaded
//
///
/// The base address at which the image was loaded.
///
VOID *ImageBase;
///
/// The size in bytes of the loaded image.
///
UINT64 ImageSize;
EFI_MEMORY_TYPE ImageCodeType;
EFI_MEMORY_TYPE ImageDataType;