Add comments for IntelFrameworkModulePkg Header file.

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Guid / DataHubStatusCodeRecord.h

diff --git a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
index cbea8d56f94709e049c44d0cd249c210458d0d2d..0f11c7a8b6f5c1a595117db87e777eb302859f74 100644 (file)
--- 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.
 **/\r
 \r
 \r
-#ifndef __STATUS_CODE_H__\r
-#define __STATUS_CODE_H__\r
+#ifndef __DATA_HUB_STATUS_CODE_RECORD_H__\r
+#define __DATA_HUB_STATUS_CODE_RECORD_H__\r
 \r
 #define EFI_DATA_HUB_STATUS_CODE_RECORD_GUID \\r
   { \\r
@@ -22,14 +22,34 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
   }\r
 \r
 typedef struct {\r
+  ///\r
+  /// Status Code type to be reported.\r
+  ///\r
   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
+  ///\r
   EFI_STATUS_CODE_VALUE Value;\r
+\r
+  ///\r
+  /// The enumeration of a hardware or software entity within\r
+  /// the system. Valid instance numbers start with 1\r
+  ///\r
   UINT32                Instance;\r
+\r
+  ///\r
+  /// Identify the caller.\r
+  ///\r
   EFI_GUID              CallerId;\r
+\r
+  ///\r
+  /// Additional status code data\r
+  ///\r
   EFI_STATUS_CODE_DATA  Data;\r
 } DATA_HUB_STATUS_CODE_DATA_RECORD;\r
 \r
 extern EFI_GUID gEfiDataHubStatusCodeRecordGuid;\r
 \r
-#endif // __STATUS_CODE_H__\r
-\r
+#endif\r