Minor update the comments style for LegacyRegion2 protocol

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9466 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Protocol/LegacyRegion2.h b/MdePkg/Include/Protocol/LegacyRegion2.h
index 195e3e0cec730aa67a0824cfafebaa17843e8944..070bf6ba1b3a6e78990bd1ba9db56ef8e3e81fa9 100644 (file)
--- a/MdePkg/Include/Protocol/LegacyRegion2.h
+++ b/MdePkg/Include/Protocol/LegacyRegion2.h
@@ -174,14 +174,25 @@ typedef enum {
 \r
 \r
 typedef struct {\r
-  UINT32                      Start;       ///< The beginning of the physical address of this\r
-                                           ///< region.\r
-  UINT32                      Length;      ///< The number of bytes in this region.\r
-  EFI_LEGACY_REGION_ATTRIBUTE Attribute;   ///< Attribute of the Legacy Region Descriptor that\r
-                                           ///< describes the capabilities for that memory region.  \r
-  UINT32                      Granularity; ///< Describes the byte length programmability\r
-                                           ///< associated with the Start address and the specified\r
-                                           ///< Attribute setting.\r
+  ///\r
+  /// The beginning of the physical address of this\r
+  /// region.\r
+  ///\r
+  UINT32                      Start;\r
+  ///\r
+  /// The number of bytes in this region.\r
+  ///\r
+  UINT32                      Length;\r
+  ///\r
+  /// Attribute of the Legacy Region Descriptor that\r
+  /// describes the capabilities for that memory region.\r
+  ///\r
+  EFI_LEGACY_REGION_ATTRIBUTE Attribute;\r
+  ///\r
+  /// Describes the byte length programmability\r
+  /// associated with the Start address and the specified\r
+  /// Attribute setting.\r
+  UINT32                      Granularity;\r
 } EFI_LEGACY_REGION_DESCRIPTOR;\r
 \r
 \r
@@ -213,28 +224,18 @@ EFI_STATUS
   );\r
 \r
 \r
-/**\r
-  Abstracts the hardware control of the physical address region 0xC0000-0xFFFFF.\r
-\r
-  The EFI_LEGACY_REGION2_PROTOCOL is used to abstract the hardware control of the memory \r
-  attributes of the Option ROM shadowing region, 0xC0000 to 0xFFFFF.\r
-  \r
-  There are three memory attributes that can be modified through this protocol: read, write and\r
-  boot-lock. These protocols may be set in any combination.\r
-\r
-**/\r
+/// \r
+/// The EFI_LEGACY_REGION2_PROTOCOL is used to abstract the hardware control of the memory \r
+/// attributes of the Option ROM shadowing region, 0xC0000 to 0xFFFFF.\r
+/// There are three memory attributes that can be modified through this protocol: read, write and\r
+/// boot-lock. These protocols may be set in any combination.\r
+///\r
 struct _EFI_LEGACY_REGION2_PROTOCOL {\r
-  EFI_LEGACY_REGION2_DECODE     Decode;     ///< Modify the read attribute of a memory region. See\r
-                                            ///< the Decode() function description.\r
-  EFI_LEGACY_REGION2_LOCK       Lock;       ///< Modify the write attribute of a memory region to\r
-                                            ///< prevent writes. See the Lock() function description.\r
-  EFI_LEGACY_REGION2_BOOT_LOCK  BootLock;   ///< Modify the boot-lock attribute of a memory region to\r
-                                            ///< prevent future changes to the memory attributes for\r
-                                            ///< this region. See the BootLock() function description.\r
-  EFI_LEGACY_REGION2_UNLOCK     UnLock;     ///< Modify the write attribute of a memory region to\r
-                                            ///< allow writes. See the Unlock() function description. \r
-  EFI_LEGACY_REGION_GET_INFO    GetInfo;    ///< Modify the write attribute of a memory region to\r
-                                            ///< allow writes. See the GetInfo() function description.\r
+  EFI_LEGACY_REGION2_DECODE     Decode;\r
+  EFI_LEGACY_REGION2_LOCK       Lock;\r
+  EFI_LEGACY_REGION2_BOOT_LOCK  BootLock;\r
+  EFI_LEGACY_REGION2_UNLOCK     UnLock;\r
+  EFI_LEGACY_REGION_GET_INFO    GetInfo;\r
 };\r
 \r
 extern EFI_GUID gEfiLegacyRegion2ProtocolGuid;\r