Update comments for Protocol definitions to match UEFI spec.

[mirror_edk2.git] / MdePkg / Include / Protocol / Runtime.h

diff --git a/MdePkg/Include/Protocol/Runtime.h b/MdePkg/Include/Protocol/Runtime.h
index 5fb8aee7ca75ab257bd47909e89ed538300d627b..718f9dca5c2fe61122ea8ffc7a8153e5a2a0f088 100644 (file)
--- a/MdePkg/Include/Protocol/Runtime.h
+++ b/MdePkg/Include/Protocol/Runtime.h
@@ -27,17 +27,17 @@
 #ifndef __ARCH_PROTOCOL_RUNTIME_H__\r
 #define __ARCH_PROTOCOL_RUNTIME_H__\r
 \r
-//\r
-// Global ID for the Runtime Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Runtime Architectural Protocol\r
+///\r
 #define EFI_RUNTIME_ARCH_PROTOCOL_GUID \\r
   { 0xb7dfb4e1, 0x52f, 0x449f, {0x87, 0xbe, 0x98, 0x18, 0xfc, 0x91, 0xb7, 0x33 } }\r
 \r
 typedef struct _EFI_RUNTIME_ARCH_PROTOCOL  EFI_RUNTIME_ARCH_PROTOCOL;\r
 \r
-//\r
-// LIST_ENTRY from BaseType \r
-//\r
+///\r
+/// LIST_ENTRY from BaseType \r
+///\r
 typedef LIST_ENTRY EFI_LIST_ENTRY;\r
 \r
 typedef struct _EFI_RUNTIME_IMAGE_ENTRY  EFI_RUNTIME_IMAGE_ENTRY;\r
@@ -61,59 +61,27 @@ struct _EFI_RUNTIME_EVENT_ENTRY {
   EFI_LIST_ENTRY          Link;\r
 };\r
 \r
-//\r
-// Interface stucture for the Runtime Architectural Protocol\r
-//\r
-/**\r
-  @par Protocol Description:\r
-  Allows the runtime functionality of the DXE Foundation to be contained in a \r
-  separate driver. It also provides hooks for the DXE Foundation to export \r
-  information that is needed at runtime. As such, this protocol allows the DXE \r
-  Foundation to manage runtime drivers and events. This protocol also implies \r
-  that the runtime services required to transition to virtual mode, \r
-  SetVirtualAddressMap() and ConvertPointer(), have been registered into the \r
-  EFI Runtime Table in the EFI System Partition.  This protocol must be produced \r
-  by a runtime DXE driver and may only be consumed by the DXE Foundation.\r
-\r
-  @param ImageHead\r
-  A list of type EFI_RUNTIME_IMAGE_ENTRY.\r
-\r
-  @param EventHead\r
-  A list of type EFI_RUNTIME_EVENT_ENTRY.\r
-\r
-  @param MemoryDescriptorSize\r
-  Size of a memory descriptor that is return by GetMemoryMap().\r
-\r
-  @param MemoryDescriptorVersion\r
-  Version of a memory descriptor that is return by GetMemoryMap().\r
-\r
-  @param MemoryMapSize \r
-  Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual. \r
-\r
-  @param MemoryMapPhysical\r
-  Pointer to a runtime buffer that contains a copy of \r
-  the memory map returned via GetMemoryMap().\r
-\r
-  @param MemoryMapVirtual\r
-  Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap().\r
-\r
-  @param VirtualMode\r
-  Boolean that is TRUE if SetVirtualAddressMap() has been called.\r
-\r
-  @param AtRuntime\r
-  Boolean that is TRUE if ExitBootServices () has been called.\r
-\r
-**/\r
+///\r
+/// Allows the runtime functionality of the DXE Foundation to be contained in a \r
+/// separate driver. It also provides hooks for the DXE Foundation to export \r
+/// information that is needed at runtime. As such, this protocol allows the DXE \r
+/// Foundation to manage runtime drivers and events. This protocol also implies \r
+/// that the runtime services required to transition to virtual mode, \r
+/// SetVirtualAddressMap() and ConvertPointer(), have been registered into the \r
+/// EFI Runtime Table in the EFI System Partition.  This protocol must be produced \r
+/// by a runtime DXE driver and may only be consumed by the DXE Foundation.\r
+///\r
 struct _EFI_RUNTIME_ARCH_PROTOCOL {\r
-  EFI_LIST_ENTRY          ImageHead;\r
-  EFI_LIST_ENTRY          EventHead;\r
-  UINTN                   MemoryDescriptorSize;\r
-  UINT32                  MemoryDesciptorVersion;\r
-  UINTN                   MemoryMapSize;\r
-  EFI_MEMORY_DESCRIPTOR   *MemoryMapPhysical;\r
-  EFI_MEMORY_DESCRIPTOR   *MemoryMapVirtual;\r
-  BOOLEAN                 VirtualMode;\r
-  BOOLEAN                 AtRuntime;\r
+  EFI_LIST_ENTRY          ImageHead;    ///< A list of type EFI_RUNTIME_IMAGE_ENTRY.\r
+  EFI_LIST_ENTRY          EventHead;    ///< A list of type EFI_RUNTIME_EVENT_ENTRY.\r
+  UINTN                   MemoryDescriptorSize;   ///< Size of a memory descriptor that is return by GetMemoryMap().\r
+  UINT32                  MemoryDesciptorVersion; ///< Version of a memory descriptor that is return by GetMemoryMap().\r
+  UINTN                   MemoryMapSize;///< Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual. \r
+  EFI_MEMORY_DESCRIPTOR   *MemoryMapPhysical;     ///< Pointer to a runtime buffer that contains a copy of \r
+                                                  ///< the memory map returned via GetMemoryMap().\r
+  EFI_MEMORY_DESCRIPTOR   *MemoryMapVirtual;      ///< Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap().\r
+  BOOLEAN                 VirtualMode;  ///< Boolean that is TRUE if SetVirtualAddressMap() has been called.\r
+  BOOLEAN                 AtRuntime;    ///< Boolean that is TRUE if ExitBootServices () has been called.\r
 };\r
 \r
 extern EFI_GUID gEfiRuntimeArchProtocolGuid;\r