Fix doxygen comment for structure and macro

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

diff --git a/MdePkg/Include/Protocol/Runtime.h b/MdePkg/Include/Protocol/Runtime.h
index 401aceca6c765b7dcab6a7be8413918cc9106e56..355fa83fee976640be27134b82a5fbd426c3ac49 100644 (file)
--- a/MdePkg/Include/Protocol/Runtime.h
+++ b/MdePkg/Include/Protocol/Runtime.h
@@ -1,7 +1,7 @@
 /** @file\r
-  Runtime Architectural Protocol as defined in DXE CIS\r
+  Runtime Architectural Protocol as defined in PI Specification VOLUME 2 DXE\r
 \r
-  This code is used to produce the EFI 1.0 runtime virtual switch over\r
+  This code is used to produce the UEFI 2.0 runtime virtual switch over\r
 \r
   This driver must add SetVirtualAddressMap () and ConvertPointer () to\r
   the EFI system table. This driver is not responcible for CRCing the \r
@@ -13,7 +13,7 @@
   by this driver to produce the runtime transition to virtual mode\r
   calling.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -22,25 +22,22 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  @par Revision Reference:\r
-  Version 0.91.\r
-\r
 **/\r
 \r
 #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
@@ -77,45 +74,52 @@ struct _EFI_RUNTIME_EVENT_ENTRY {
   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
 struct _EFI_RUNTIME_ARCH_PROTOCOL {\r
+  ///\r
+  /// A list of type EFI_RUNTIME_IMAGE_ENTRY.\r
+  ///\r
   EFI_LIST_ENTRY          ImageHead;\r
+  \r
+  ///\r
+  /// A list of type EFI_RUNTIME_EVENT_ENTRY.\r
+  ///\r
   EFI_LIST_ENTRY          EventHead;\r
+  \r
+  ///\r
+  /// Size of a memory descriptor that is return by GetMemoryMap().\r
+  ///\r
   UINTN                   MemoryDescriptorSize;\r
+  \r
+  ///\r
+  /// Version of a memory descriptor that is return by GetMemoryMap().\r
+  ///\r
   UINT32                  MemoryDesciptorVersion;\r
+  \r
+  ///\r
+  /// Size of the memory map in bytes contained in MemoryMapPhysical and MemoryMapVirtual. \r
+  ///\r
   UINTN                   MemoryMapSize;\r
+  \r
+  ///\r
+  /// Pointer to a runtime buffer that contains a copy of \r
+  /// the memory map returned via GetMemoryMap().\r
+  ///\r
   EFI_MEMORY_DESCRIPTOR   *MemoryMapPhysical;\r
+  \r
+  ///\r
+  /// Pointer to MemoryMapPhysical that is updated to virtual mode after SetVirtualAddressMap().\r
+  ///\r
   EFI_MEMORY_DESCRIPTOR   *MemoryMapVirtual;\r
+  \r
+  ///\r
+  /// Boolean that is TRUE if SetVirtualAddressMap() has been called.\r
+  ///\r
   BOOLEAN                 VirtualMode;\r
+  \r
+  ///\r
+  /// Boolean that is TRUE if ExitBootServices () has been called.\r
+  ///\r
   BOOLEAN                 AtRuntime;\r
 };\r
 \r