Committing changes to the comments, to improve code documentation.

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

diff --git a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
index 8ebc3697940839e5d8653eb240d3335921b03c9e..5922d536f163154da8851e5ee9e8917c90c55c1f 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
+++ b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
@@ -34,8 +34,8 @@ typedef struct {
   EFI_STATUS_CODE_TYPE   CodeType;\r
 \r
   ///\r
-  /// Value information about the class and subclass is used to\r
-  /// classify the hardware and software entity as well as an operation.\r
+  /// An operation, plus value information about the class and subclass, used to\r
+  /// classify the hardware and software entity.\r
   ///\r
   EFI_STATUS_CODE_VALUE  Value;\r
 \r

diff --git a/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h b/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h
index c435aab8f937d93dbe2d8634c5d94d7674b69378..7599926f12e565e3f4b461e3680c4a078df1557e 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h
+++ b/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h
@@ -17,7 +17,7 @@
 \r
 ///\r
 /// Global ID used to identify GUIDed HOBs that start with a structure of type \r
-/// MEMORY_STATUSCODE_PACKET_HEADER followed by an arry of structures of type \r
+/// MEMORY_STATUSCODE_PACKET_HEADER followed by an array of structures of type \r
 /// MEMORY_STATUSCODE_RECORD.  These GUIDed HOBs record all the information \r
 /// passed into the ReportStatusCode() service of PEI Services Table.\r
 ///\r
@@ -66,8 +66,8 @@ typedef struct {
   EFI_STATUS_CODE_TYPE   CodeType;\r
 \r
   ///\r
-  /// Valu information about the class and subclass is used to\r
-  /// classify the hardware and software entity as well as an operation.\r
+  /// An operation, plus value information about the class and subclass, used to\r
+  /// classify the hardware and software entity.\r
   ///\r
   EFI_STATUS_CODE_VALUE  Value;\r
 \r

diff --git a/IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h b/IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h
index ee679cf0eb7435c9db00734120a2e4fb35de50aa..e87947735f736b2dc6e327cb599308151339d78f 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h
+++ b/IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h
@@ -30,10 +30,10 @@
 #define EFI_STATUS_CODE_DATA_MAX_SIZE 200\r
 \r
 ///\r
-/// This structure contains the ErrorLevel passed into the DEBUG() macro followed \r
+/// This structure contains the ErrorLevel passed into the DEBUG() macro, followed \r
 /// by a 96-byte buffer that contains the variable argument list passed to the \r
 //  DEBUG() macro that has been converted to a BASE_LIST.  The 96-byte buffer is \r
-/// followed by a Null terminated ASCII string that is the Format string passed \r
+/// followed by a Null-terminated ASCII string that is the Format string passed \r
 /// to the DEBUG() macro.  The maximum size of this structure is defined by \r
 /// EFI_STATUS_CODE_DATA_MAX_SIZE.\r
 ///\r