diff options
| author | klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-10-09 19:17:35 +0000 |
|---|---|---|
| committer | klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-10-09 19:17:35 +0000 |
| commit | 1f08a159034549216eccfd533b50b712d944d844 (patch) | |
| tree | c4a4b16daa6f02b29896c96007b94112ae51d54c /MdePkg/Include/Protocol/Runtime.h | |
| parent | cce6f7aa66125df1bddf24c122f02093d47ef204 (diff) | |
| download | edk2-1f08a159034549216eccfd533b50b712d944d844.tar.gz edk2-1f08a159034549216eccfd533b50b712d944d844.tar.bz2 edk2-1f08a159034549216eccfd533b50b712d944d844.zip | |
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
Diffstat (limited to 'MdePkg/Include/Protocol/Runtime.h')
| -rw-r--r-- | MdePkg/Include/Protocol/Runtime.h | 65 |
1 files changed, 36 insertions, 29 deletions
diff --git a/MdePkg/Include/Protocol/Runtime.h b/MdePkg/Include/Protocol/Runtime.h index 32c3359af8..355fa83fee 100644 --- a/MdePkg/Include/Protocol/Runtime.h +++ b/MdePkg/Include/Protocol/Runtime.h @@ -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;
};
|