Add Doxygen comment block to SMRAM state macro definitions.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Guid / SmramMemoryReserve.h

diff --git a/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h b/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
index 8dece94a94391497bc5ac7c1b42d97ce2f5d3a36..870622a63f916f65fe699a1480ad45adfe0eb160 100644 (file)
--- a/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
+++ b/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
@@ -41,24 +41,23 @@ typedef struct {
   UINT64                RegionState;    ///< Describes the accessibility attributes of the SMRAM.\r
 } EFI_SMRAM_DESCRIPTOR;\r
 \r
-//\r
-// Definition of SMRAM states, used as value for EFI_SMRAM_DESCRIPTOR.RegionState.\r
-//\r
+///\r
+/// Definition of SMRAM states, used as value for EFI_SMRAM_DESCRIPTOR.RegionState.\r
+///@{\r
 #define EFI_SMRAM_OPEN                0x00000001\r
 #define EFI_SMRAM_CLOSED              0x00000002\r
 #define EFI_SMRAM_LOCKED              0x00000004\r
 #define EFI_CACHEABLE                 0x00000008\r
 #define EFI_ALLOCATED                 0x00000010\r
+///@}\r
 \r
-///\r
-/// Inconsistent with specification here: \r
-/// EFI_HOB_SMRAM_DESCRIPTOR_BLOCK has been changed to EFI_SMRAM_HOB_DESCRIPTOR_BLOCK.\r
-/// This inconsistency is kept in code in order for backward compatibility.\r
-///\r
-\r
-///\r
-/// GUID specific data structure of HOB for reserving SMRAM regions.\r
-///\r
+/**\r
+* GUID specific data structure of HOB for reserving SMRAM regions.\r
+*\r
+* Inconsistent with specification here: \r
+* EFI_HOB_SMRAM_DESCRIPTOR_BLOCK has been changed to EFI_SMRAM_HOB_DESCRIPTOR_BLOCK.\r
+* This inconsistency is kept in code in order for backward compatibility.\r
+**/\r
 typedef struct {\r
   ///\r
   /// Designates the number of possible regions in the system\r
@@ -75,3 +74,4 @@ typedef struct {
 extern EFI_GUID gEfiSmmPeiSmramMemoryReserveGuid;\r
 \r
 #endif\r
+\r