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 32c3359af84d7dcc63bb09eb689cc630a01ec56b..355fa83fee976640be27134b82a5fbd426c3ac49 100644 (file)
--- 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 \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