Committing changes to the comments, to improve code documentation.

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

10 files changed, 50 insertions, 55 deletions

diff --git a/MdeModulePkg/Include/Guid/CapsuleVendor.h b/MdeModulePkg/Include/Guid/CapsuleVendor.h
index dc6cb2fefa..ae77f1f6e5 100644
--- a/MdeModulePkg/Include/Guid/CapsuleVendor.h
+++ b/MdeModulePkg/Include/Guid/CapsuleVendor.h
@@ -1,7 +1,9 @@
 /** @file

-  This file defines capsule vendor guid for capsule variable and hob.

-  It also defines capsule variable name and capsule guid hob data structure,

-  which can be used to store the capsule image start address and length.

+  This file defines:

+  * the capsule vendor GUID for capsule variables and the HOB

+  * the capsule variable name

+  * the capsule GUID HOB data structure.

+  The capsule HOB and variable can be used to store the capsule image start address and length.

   They are used by EDKII implementation of capsule update across a system reset.

 

 Copyright (c) 2006 - 2008, Intel Corporation

diff --git a/MdeModulePkg/Include/Guid/ConsoleInDevice.h b/MdeModulePkg/Include/Guid/ConsoleInDevice.h
index e40029a2a3..81c2d93505 100644
--- a/MdeModulePkg/Include/Guid/ConsoleInDevice.h
+++ b/MdeModulePkg/Include/Guid/ConsoleInDevice.h
@@ -1,9 +1,8 @@
 /** @file

-  This guid is used to specify the device is the console in device.

-  If the device is the console in device, this guid as the protocol guid

-  will be installed into this device handle.

+  This GUID can be installed to the device handle to specify that the device is the console-in device.

+  

 

-Copyright (c) 2006 - 2008, Intel Corporation

+Copyright (c) 2006 - 2009, Intel Corporation

 All rights reserved. This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

diff --git a/MdeModulePkg/Include/Guid/ConsoleOutDevice.h b/MdeModulePkg/Include/Guid/ConsoleOutDevice.h
index aabbd5edcd..f09f427e44 100644
--- a/MdeModulePkg/Include/Guid/ConsoleOutDevice.h
+++ b/MdeModulePkg/Include/Guid/ConsoleOutDevice.h
@@ -1,9 +1,7 @@
 /** @file

-  This guid is used to specify the device is the console out device.

-  If the device is the console out device, this guid as the protocol guid

-  will be installed into this device handle.

+  This GUID can be installed to the device handle to specify that the device is the console-out device.

 

-Copyright (c) 2006 - 2008, Intel Corporation

+Copyright (c) 2006 - 2009, Intel Corporation

 All rights reserved. This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

diff --git a/MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h b/MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h
index d117235308..aab340b55d 100644
--- a/MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h
+++ b/MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h
@@ -1,9 +1,9 @@
 /** @file

 

   This file defines a group of guids to specify the different 

-  encapsulation scheme for the guided section.

+  encapsulation scheme for the GUIDed section.

 

-  Now, only one guid is defined for CRC32 encapsulation scheme.

+  Only one GUID is defined for the CRC32 encapsulation scheme.

 

   Copyright (c) 2006 - 2009, Intel Corporation

   All rights reserved. This program and the accompanying materials

@@ -20,9 +20,8 @@
 #define __CRC32_GUIDED_SECTION_EXTRACTION_H__

 

 //

-// GUID definition. Each GUIDed section extraction protocol has the

-// same interface but with different GUID. All the GUIDs is defined here.

-// May add more GUIDs here in future.

+// GUID definition. All GUIDed section extraction protocols share the

+// same interface, but each has a different GUID. All the GUIDs are defined here.

 //

 #define EFI_CRC32_GUIDED_SECTION_EXTRACTION_GUID \

   { 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } }

diff --git a/MdeModulePkg/Include/Guid/MdeModuleHii.h b/MdeModulePkg/Include/Guid/MdeModuleHii.h
index f5795ef31f..5cfc45cec3 100644
--- a/MdeModulePkg/Include/Guid/MdeModuleHii.h
+++ b/MdeModulePkg/Include/Guid/MdeModuleHii.h
@@ -151,7 +151,7 @@ typedef struct _EFI_IFR_GUID_SUBCLASS {
   { 0x31ca5d1a, 0xd511, 0x4931, { 0xb7, 0x82, 0xae, 0x6b, 0x2b, 0x17, 0x8c, 0xd7 } }

 

 ///

-/// Two extended opcode are added, new extension can be added here later.

+/// Two extended opcodes are added, and new extensions can be added here later.

 /// One is for framework OneOf question Option Key value,

 /// Another is for framework vareqval.

 ///

diff --git a/MdeModulePkg/Include/Guid/MemoryTypeInformation.h b/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
index 12fa8274fa..f2c0ae3fcd 100644
--- a/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
+++ b/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
@@ -1,6 +1,6 @@
 /** @file

-  This file defines the memory type information guid for its variable and guid. 

-  It also defines memory type info variable name and data structure for variable and hob both,

+  This file defines the memory type information GUID for its variable and guid. 

+  It also defines memory type info variable name and data structure for both variable and hob,

   which can be used to store the information for each memory type in EFI variable or HOB.

 

 Copyright (c) 2006 - 2008, Intel Corporation. <BR>

diff --git a/MdeModulePkg/Include/Guid/NicIp4ConfigNvData.h b/MdeModulePkg/Include/Guid/NicIp4ConfigNvData.h
index 94a2a5b5bf..5e27477d42 100644
--- a/MdeModulePkg/Include/Guid/NicIp4ConfigNvData.h
+++ b/MdeModulePkg/Include/Guid/NicIp4ConfigNvData.h
@@ -38,12 +38,10 @@ typedef enum {
 

 //

 // The following structures are used by drivers/applications other

-// than EFI_IP4_PROTOCOL, such as ifconfig shell application, to

-// communicate the IP configuration information to EFI_IP4_CONFIG_PROTOCOL.

-// EFI_IP4_CONFIG_PROTOCOL in turn is used by EFI_IP4_PROTOCOL to get

-// the default IP4 configuration. ifconfig can't use the EFI_IP4_PROTOCOL

-// because it don't know how to configure the default IP address even

-// it has got the address.

+// than EFI_IP4_PROTOCOL, such as the ifconfig shell application, to

+// communicate the IP configuration information to the EFI_IP4_CONFIG_PROTOCOL.

+// The EFI_IP4_PROTOCOL uses the EFI_IP4_CONFIG_PROTOCOL to get

+// the default IP4 configuration.

 //

 

 ///

diff --git a/MdeModulePkg/Include/Guid/Performance.h b/MdeModulePkg/Include/Guid/Performance.h
index 14c7c83d51..b59fe81040 100644
--- a/MdeModulePkg/Include/Guid/Performance.h
+++ b/MdeModulePkg/Include/Guid/Performance.h
@@ -1,6 +1,8 @@
 /** @file

-  This file defines performance related definitions: the format of performance

-  GUID HOB, performance protocol interfaces and performance variable format.  

+  This file defines performance-related definitions, including the format of:

+  * performance GUID HOB

+  * performance protocol interfaces

+  * performance variables.  

 

 Copyright (c) 2009, Intel Corporation. <BR>

 All rights reserved. This program and the accompanying materials

@@ -94,7 +96,7 @@ typedef struct {
 // The header must be aligned at 8 bytes

 //

 typedef struct {

-  UINT32                NumberOfEntries; ///> The number of all performance guage entries

+  UINT32                NumberOfEntries; ///> The number of all performance gauge entries

   UINT32                Reserved;

 } GAUGE_DATA_HEADER;

 

@@ -102,9 +104,8 @@ typedef struct {
   Adds a record at the end of the performance measurement log

   that records the start time of a performance measurement.

 

-  Adds a record to the end of the performance measurement log

-  that contains the Handle, Token, and Module.

-  The end time of the new record must be set to zero.

+  The added record contains the Handle, Token, and Module.

+  The end time of the new record is not recorded, so it is set to zero.

   If TimeStamp is not zero, then TimeStamp is used to fill in the start time in the record.

   If TimeStamp is zero, the start time in the record is filled in with the value

   read from the current time stamp.

@@ -172,13 +173,11 @@ EFI_STATUS
 

   @param  LogEntryKey             The key for the previous performance measurement log entry.

                                   If 0, then the first performance measurement log entry is retrieved.

-  @param  GaugeDataEntry          The indirect pointer to the gauge data entry specified by LogEntryKey

-                                  if the retrieval is successful.

-

+  @param  GaugeDataEntry          Out parameter for the indirect pointer to the gauge data entry specified by LogEntryKey.

+                                  

   @retval EFI_SUCCESS             The GuageDataEntry is successfully found based on LogEntryKey.

-  @retval EFI_NOT_FOUND           The LogEntryKey is the last entry (equals to the total entry number).

-  @retval EFI_INVALIDE_PARAMETER  The LogEntryKey is not a valid entry (greater than the total entry number).

-  @retval EFI_INVALIDE_PARAMETER  GaugeDataEntry is NULL.

+  @retval EFI_NOT_FOUND           There is no entry after the measurement referred to by LogEntryKey.

+  @retval EFI_INVALID_PARAMETER   The LogEntryKey is not a valid entry, or GaugeDataEntry is NULL.

 

 **/

 typedef

diff --git a/MdeModulePkg/Include/Guid/StandardErrorDevice.h b/MdeModulePkg/Include/Guid/StandardErrorDevice.h
index 95d6f269dd..f464fb7040 100644
--- a/MdeModulePkg/Include/Guid/StandardErrorDevice.h
+++ b/MdeModulePkg/Include/Guid/StandardErrorDevice.h
@@ -1,9 +1,8 @@
 /** @file

-  This guid is used to specify the device is the StdErr device.

-  If the device is the StdErr device, this guid as the protocol guid

-  will be installed into this device handle.

+  This GUID is installed to the device handler to specify that the device is StdErr device.

+  

 

-Copyright (c) 2006 - 2008, Intel Corporation

+Copyright (c) 2006 - 2009, Intel Corporation

 All rights reserved. This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

diff --git a/MdeModulePkg/Include/Guid/VariableFormat.h b/MdeModulePkg/Include/Guid/VariableFormat.h
index bf1c6b3687..8ff64cb2c8 100644
--- a/MdeModulePkg/Include/Guid/VariableFormat.h
+++ b/MdeModulePkg/Include/Guid/VariableFormat.h
@@ -1,6 +1,6 @@
 /** @file

-  The variable data structures are related to EDK II specific UEFI variable implementation.

-  Variable data header and Variable storage region header are defined here.

+  The variable data structures are related to EDK II-specific implementation of UEFI variables.

+  VariableFormat.h defines variable data headers and variable storage region headers.

 

   Copyright (c) 2006 - 2008 Intel Corporation. <BR>

   All rights reserved. This program and the accompanying materials

@@ -22,8 +22,9 @@
 extern EFI_GUID gEfiVariableGuid;

 

 ///

-/// Alignment of variable name and data.

-/// For IA32/X64 architecture, the alignment is set to 1, and 8 is for IPF archtecture.

+/// Alignment of variable name and data, according to the architecture:

+/// * For IA-32 and Intel(R) 64 architectures: 1

+/// * For IA-64 architecture: 8

 ///

 #if defined (MDE_CPU_IPF)

 #define ALIGNMENT         8

@@ -32,7 +33,7 @@ extern EFI_GUID gEfiVariableGuid;
 #endif

 

 //

-// GET_PAD_SIZE to calculate miminal pad bytes to make current size satisfy the alignment requirement

+// GET_PAD_SIZE calculates the miminal pad bytes needed to make the current pad size satisfy the alignment requirement.

 //

 #if (ALIGNMENT == 1)

 #define GET_PAD_SIZE(a) (0)

@@ -99,7 +100,7 @@ typedef struct {
 ///

 /// Variable State flags

 ///

-#define VAR_IN_DELETED_TRANSITION     0xfe  ///< Variable is in obsolete transistion

+#define VAR_IN_DELETED_TRANSITION     0xfe  ///< Variable is in obsolete transition

 #define VAR_DELETED                   0xfd  ///< Variable is obsolete

 #define VAR_HEADER_VALID_ONLY         0x7f  ///< Variable header has been valid

 #define VAR_ADDED                     0x3f  ///< Variable has been completely added

@@ -122,7 +123,7 @@ typedef struct {
   ///

   UINT32      Attributes;

   ///

-  /// Size of variable Null-terminated Unicode string name

+  /// Size of variable null-terminated Unicode string name

   ///

   UINT32      NameSize;

   ///

@@ -130,7 +131,7 @@ typedef struct {
   ///

   UINT32      DataSize;

   ///

-  /// A unique identifier for the vendor that produce and consume this varaible.

+  /// A unique identifier for the vendor that produces and consumes this varaible.

   ///

   EFI_GUID    VendorGuid;

 } VARIABLE_HEADER;

@@ -141,7 +142,7 @@ typedef struct _VARIABLE_INFO_ENTRY  VARIABLE_INFO_ENTRY;
 

 ///

 /// This structure contains the variable list that is put in EFI system table.

-/// The variable driver collects all used variables at boot service time and produce this list.

+/// The variable driver collects all variables that were used at boot service time and produces this list.

 /// This is an optional feature to dump all used variables in shell environment. 

 ///

 struct _VARIABLE_INFO_ENTRY {

@@ -149,11 +150,11 @@ struct _VARIABLE_INFO_ENTRY {
   EFI_GUID            VendorGuid;  ///> Guid of Variable 

   CHAR16              *Name;       ///> Name of Variable 

   UINT32              Attributes;  ///> Attributes of variable defined in UEFI spec

-  UINT32              ReadCount;   ///> Times to read this variable

-  UINT32              WriteCount;  ///> Times to write this variable

-  UINT32              DeleteCount; ///> Times to delete this variable

-  UINT32              CacheCount;  ///> Times that cache hits this variable

-  BOOLEAN             Volatile;    ///> TRUE if volatile FALSE if non-volatile

+  UINT32              ReadCount;   ///> Number of times to read this variable

+  UINT32              WriteCount;  ///> Number of times to write this variable

+  UINT32              DeleteCount; ///> Number of times to delete this variable

+  UINT32              CacheCount;  ///> Number of times that cache hits this variable

+  BOOLEAN             Volatile;    ///> TRUE if volatile, FALSE if non-volatile

 };

 

 #endif // _EFI_VARIABLE_H_