Add additional comments for structure definition.

[mirror_edk2.git] / MdeModulePkg / Include / Guid / VariableInfo.h

diff --git a/MdeModulePkg/Include/Guid/VariableInfo.h b/MdeModulePkg/Include/Guid/VariableInfo.h
index e63224fd5b8b3e1b23fc64a5d4c97d45050a1bd6..45a7b87cb6aa482bea3214783ff427d81da9f01c 100644 (file)
--- a/MdeModulePkg/Include/Guid/VariableInfo.h
+++ b/MdeModulePkg/Include/Guid/VariableInfo.h
@@ -24,21 +24,20 @@ extern EFI_GUID gEfiVariableInfoGuid;
 \r
 typedef struct _VARIABLE_INFO_ENTRY  VARIABLE_INFO_ENTRY;\r
 \r
-//\r
-// This list gets put in the EFI system table. It is produced by the Variable driver at\r
-// Boot Services time and records read and write access to a given variable\r
-//\r
+///\r
+/// This list gets put in the EFI system table. It is produced by the Variable driver at\r
+/// Boot Services time and records read and write access to a given variable\r
+///\r
 struct _VARIABLE_INFO_ENTRY {\r
-  VARIABLE_INFO_ENTRY *Next;\r
-  EFI_GUID            VendorGuid;\r
-  CHAR16              *Name;\r
-  UINT32              Attributes;\r
-  UINT32              ReadCount;\r
-  UINT32              WriteCount;\r
-  UINT32              DeleteCount;\r
-  UINT32              CacheCount;\r
-  BOOLEAN             Volatile;\r
+  VARIABLE_INFO_ENTRY *Next;       /// Pointer to next entry\r
+  EFI_GUID            VendorGuid;  /// Guid of Variable \r
+  CHAR16              *Name;       /// Name of Variable \r
+  UINT32              Attributes;  /// Attributes of variable defined in UEFI spec\r
+  UINT32              ReadCount;   /// Times to read this variable\r
+  UINT32              WriteCount;  /// Times to write this variable\r
+  UINT32              DeleteCount; /// Times to delete this variable\r
+  UINT32              CacheCount;  /// Times that cache hits this variable\r
+  BOOLEAN             Volatile;    /// TRUE if volatile FALSE if non-volatile\r
 };\r
 \r
-\r
 #endif\r