Add comments for IntelFrameworkModulePkg Header file.

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

1 files changed, 24 insertions, 4 deletions

diff --git a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
index cbea8d56f9..0f11c7a8b6 100644
--- a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
+++ b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
@@ -13,8 +13,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 **/

 

 

-#ifndef __STATUS_CODE_H__

-#define __STATUS_CODE_H__

+#ifndef __DATA_HUB_STATUS_CODE_RECORD_H__

+#define __DATA_HUB_STATUS_CODE_RECORD_H__

 

 #define EFI_DATA_HUB_STATUS_CODE_RECORD_GUID \

   { \

@@ -22,14 +22,34 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   }

 

 typedef struct {

+  ///

+  /// Status Code type to be reported.

+  ///

   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.

+  ///

   EFI_STATUS_CODE_VALUE Value;

+

+  ///

+  /// The enumeration of a hardware or software entity within

+  /// the system. Valid instance numbers start with 1

+  ///

   UINT32                Instance;

+

+  ///

+  /// Identify the caller.

+  ///

   EFI_GUID              CallerId;

+

+  ///

+  /// Additional status code data

+  ///

   EFI_STATUS_CODE_DATA  Data;

 } DATA_HUB_STATUS_CODE_DATA_RECORD;

 

 extern EFI_GUID gEfiDataHubStatusCodeRecordGuid;

 

-#endif // __STATUS_CODE_H__

-

+#endif