diff options
author | xli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-10-13 02:54:29 +0000 |
---|---|---|
committer | xli24 <xli24@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-10-13 02:54:29 +0000 |
commit | 44717a398fddc4df1f4aeaa70bcd7a043187ed34 (patch) | |
tree | b41f68d9d59c300d71efeeba5a12acc1bbcfb593 /MdePkg/Include/Protocol/Runtime.h | |
parent | 66eebcf94f14a0888a09f6fe5aca16563411becf (diff) | |
download | edk2-platforms-44717a398fddc4df1f4aeaa70bcd7a043187ed34.tar.xz |
Formalize comments for Protocols and PPIs.
1. Use doxygen format for Protocol/PPI data structure
2. Remove doxygen comments for function elements in Protocol/Ppi
3. Use doxygen format for data elements in Protocol/Ppi, and add missing comments where necessary
4. PEI Services Table is also updated accordingly.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6107 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Protocol/Runtime.h')
-rw-r--r-- | MdePkg/Include/Protocol/Runtime.h | 24 |
1 files changed, 10 insertions, 14 deletions
diff --git a/MdePkg/Include/Protocol/Runtime.h b/MdePkg/Include/Protocol/Runtime.h index 355fa83fee..dc56ec6be9 100644 --- a/MdePkg/Include/Protocol/Runtime.h +++ b/MdePkg/Include/Protocol/Runtime.h @@ -61,20 +61,16 @@ struct _EFI_RUNTIME_EVENT_ENTRY { EFI_LIST_ENTRY Link;
};
-//
-// Interface stucture for the Runtime Architectural Protocol
-//
-/**
- @par Protocol Description:
- Allows the runtime functionality of the DXE Foundation to be contained in a
- separate driver. It also provides hooks for the DXE Foundation to export
- information that is needed at runtime. As such, this protocol allows the DXE
- Foundation to manage runtime drivers and events. This protocol also implies
- that the runtime services required to transition to virtual mode,
- 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.
-**/
+///
+/// Allows the runtime functionality of the DXE Foundation to be contained in a
+/// separate driver. It also provides hooks for the DXE Foundation to export
+/// information that is needed at runtime. As such, this protocol allows the DXE
+/// Foundation to manage runtime drivers and events. This protocol also implies
+/// that the runtime services required to transition to virtual mode,
+/// 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.
+///
struct _EFI_RUNTIME_ARCH_PROTOCOL {
///
/// A list of type EFI_RUNTIME_IMAGE_ENTRY.
|