From 97482d9486559eaeb410088c33fa7862ed6b091c Mon Sep 17 00:00:00 2001 From: pkandel Date: Thu, 9 Jul 2009 12:37:01 +0000 Subject: [PATCH] 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 --- .../Include/Guid/DataHubStatusCodeRecord.h | 4 ++-- .../Include/Guid/MemoryStatusCodeRecord.h | 6 +++--- .../Include/Guid/StatusCodeDataTypeDebug.h | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h index 8ebc369794..5922d536f1 100644 --- a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h +++ b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h @@ -34,8 +34,8 @@ typedef struct { EFI_STATUS_CODE_TYPE CodeType; /// - /// Value information about the class and subclass is used to - /// classify the hardware and software entity as well as an operation. + /// An operation, plus value information about the class and subclass, used to + /// classify the hardware and software entity. /// EFI_STATUS_CODE_VALUE Value; diff --git a/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h b/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h index c435aab8f9..7599926f12 100644 --- a/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h +++ b/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h @@ -17,7 +17,7 @@ /// /// Global ID used to identify GUIDed HOBs that start with a structure of type -/// MEMORY_STATUSCODE_PACKET_HEADER followed by an arry of structures of type +/// MEMORY_STATUSCODE_PACKET_HEADER followed by an array of structures of type /// MEMORY_STATUSCODE_RECORD. These GUIDed HOBs record all the information /// passed into the ReportStatusCode() service of PEI Services Table. /// @@ -66,8 +66,8 @@ typedef struct { EFI_STATUS_CODE_TYPE CodeType; /// - /// Valu information about the class and subclass is used to - /// classify the hardware and software entity as well as an operation. + /// An operation, plus value information about the class and subclass, used to + /// classify the hardware and software entity. /// EFI_STATUS_CODE_VALUE Value; diff --git a/IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h b/IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h index ee679cf0eb..e87947735f 100644 --- a/IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h +++ b/IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h @@ -30,10 +30,10 @@ #define EFI_STATUS_CODE_DATA_MAX_SIZE 200 /// -/// This structure contains the ErrorLevel passed into the DEBUG() macro followed +/// This structure contains the ErrorLevel passed into the DEBUG() macro, followed /// by a 96-byte buffer that contains the variable argument list passed to the // DEBUG() macro that has been converted to a BASE_LIST. The 96-byte buffer is -/// followed by a Null terminated ASCII string that is the Format string passed +/// followed by a Null-terminated ASCII string that is the Format string passed /// to the DEBUG() macro. The maximum size of this structure is defined by /// EFI_STATUS_CODE_DATA_MAX_SIZE. /// -- 2.39.2