Committing changes to the comments, to improve code documentation.

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

diff --git a/MdeModulePkg/Include/Guid/VariableFormat.h b/MdeModulePkg/Include/Guid/VariableFormat.h
index bf1c6b3687a64e53b8e3ea6cfd6f1987df0cae46..8ff64cb2c83126016cc7cc6aa7dccf3e11a7abc9 100644 (file)
--- a/MdeModulePkg/Include/Guid/VariableFormat.h
+++ b/MdeModulePkg/Include/Guid/VariableFormat.h
@@ -1,6 +1,6 @@
 /** @file\r
-  The variable data structures are related to EDK II specific UEFI variable implementation.\r
-  Variable data header and Variable storage region header are defined here.\r
+  The variable data structures are related to EDK II-specific implementation of UEFI variables.\r
+  VariableFormat.h defines variable data headers and variable storage region headers.\r
 \r
   Copyright (c) 2006 - 2008 Intel Corporation. <BR>\r
   All rights reserved. This program and the accompanying materials\r
@@ -22,8 +22,9 @@
 extern EFI_GUID gEfiVariableGuid;\r
 \r
 ///\r
-/// Alignment of variable name and data.\r
-/// For IA32/X64 architecture, the alignment is set to 1, and 8 is for IPF archtecture.\r
+/// Alignment of variable name and data, according to the architecture:\r
+/// * For IA-32 and Intel(R) 64 architectures: 1\r
+/// * For IA-64 architecture: 8\r
 ///\r
 #if defined (MDE_CPU_IPF)\r
 #define ALIGNMENT         8\r
@@ -32,7 +33,7 @@ extern EFI_GUID gEfiVariableGuid;
 #endif\r
 \r
 //\r
-// GET_PAD_SIZE to calculate miminal pad bytes to make current size satisfy the alignment requirement\r
+// GET_PAD_SIZE calculates the miminal pad bytes needed to make the current pad size satisfy the alignment requirement.\r
 //\r
 #if (ALIGNMENT == 1)\r
 #define GET_PAD_SIZE(a) (0)\r
@@ -99,7 +100,7 @@ typedef struct {
 ///\r
 /// Variable State flags\r
 ///\r
-#define VAR_IN_DELETED_TRANSITION     0xfe  ///< Variable is in obsolete transistion\r
+#define VAR_IN_DELETED_TRANSITION     0xfe  ///< Variable is in obsolete transition\r
 #define VAR_DELETED                   0xfd  ///< Variable is obsolete\r
 #define VAR_HEADER_VALID_ONLY         0x7f  ///< Variable header has been valid\r
 #define VAR_ADDED                     0x3f  ///< Variable has been completely added\r
@@ -122,7 +123,7 @@ typedef struct {
   ///\r
   UINT32      Attributes;\r
   ///\r
-  /// Size of variable Null-terminated Unicode string name\r
+  /// Size of variable null-terminated Unicode string name\r
   ///\r
   UINT32      NameSize;\r
   ///\r
@@ -130,7 +131,7 @@ typedef struct {
   ///\r
   UINT32      DataSize;\r
   ///\r
-  /// A unique identifier for the vendor that produce and consume this varaible.\r
+  /// A unique identifier for the vendor that produces and consumes this varaible.\r
   ///\r
   EFI_GUID    VendorGuid;\r
 } VARIABLE_HEADER;\r
@@ -141,7 +142,7 @@ typedef struct _VARIABLE_INFO_ENTRY  VARIABLE_INFO_ENTRY;
 \r
 ///\r
 /// This structure contains the variable list that is put in EFI system table.\r
-/// The variable driver collects all used variables at boot service time and produce this list.\r
+/// The variable driver collects all variables that were used at boot service time and produces this list.\r
 /// This is an optional feature to dump all used variables in shell environment. \r
 ///\r
 struct _VARIABLE_INFO_ENTRY {\r
@@ -149,11 +150,11 @@ struct _VARIABLE_INFO_ENTRY {
   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
+  UINT32              ReadCount;   ///> Number of times to read this variable\r
+  UINT32              WriteCount;  ///> Number of times to write this variable\r
+  UINT32              DeleteCount; ///> Number of times to delete this variable\r
+  UINT32              CacheCount;  ///> Number of times that cache hits this variable\r
+  BOOLEAN             Volatile;    ///> TRUE if volatile, FALSE if non-volatile\r
 };\r
 \r
 #endif // _EFI_VARIABLE_H_\r