Fix doxygen comment for structure and macro

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6097 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2
2008-10-09 19:17:35 +00:00
parent cce6f7aa66
commit 1f08a15903
17 changed files with 80 additions and 387 deletions

View File

@@ -74,45 +74,52 @@ struct _EFI_RUNTIME_EVENT_ENTRY {
SetVirtualAddressMap() and ConvertPointer(), have been registered into the
EFI Runtime Table in the EFI System Partition. This protocol must be produced
by a runtime DXE driver and may only be consumed by the DXE Foundation.
@param ImageHead
A list of type EFI_RUNTIME_IMAGE_ENTRY.
@param EventHead
A list of type EFI_RUNTIME_EVENT_ENTRY.
@param MemoryDescriptorSize
Size of a memory descriptor that is return by GetMemoryMap().
@param MemoryDescriptorVersion
Version of a memory descriptor that is return by GetMemoryMap().
@param MemoryMapSize
Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual.
@param MemoryMapPhysical
Pointer to a runtime buffer that contains a copy of
the memory map returned via GetMemoryMap().
@param MemoryMapVirtual
Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap().
@param VirtualMode
Boolean that is TRUE if SetVirtualAddressMap() has been called.
@param AtRuntime
Boolean that is TRUE if ExitBootServices () has been called.
**/
struct _EFI_RUNTIME_ARCH_PROTOCOL {
///
/// A list of type EFI_RUNTIME_IMAGE_ENTRY.
///
EFI_LIST_ENTRY ImageHead;
///
/// A list of type EFI_RUNTIME_EVENT_ENTRY.
///
EFI_LIST_ENTRY EventHead;
///
/// Size of a memory descriptor that is return by GetMemoryMap().
///
UINTN MemoryDescriptorSize;
///
/// Version of a memory descriptor that is return by GetMemoryMap().
///
UINT32 MemoryDesciptorVersion;
///
/// Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual.
///
UINTN MemoryMapSize;
///
/// Pointer to a runtime buffer that contains a copy of
/// the memory map returned via GetMemoryMap().
///
EFI_MEMORY_DESCRIPTOR *MemoryMapPhysical;
///
/// Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap().
///
EFI_MEMORY_DESCRIPTOR *MemoryMapVirtual;
///
/// Boolean that is TRUE if SetVirtualAddressMap() has been called.
///
BOOLEAN VirtualMode;
///
/// Boolean that is TRUE if ExitBootServices () has been called.
///
BOOLEAN AtRuntime;
};