Update comments

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

diff --git a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
index 0f11c7a8b6f5c1a595117db87e777eb302859f74..8ebc3697940839e5d8653eb240d3335921b03c9e 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
+++ b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
@@ -1,53 +1,59 @@
 /** @file\r
-  GUID used to identify Data Hub records logged by Status Code Runtime Protocol.\r
+  GUID used to identify Data Hub records logged by Status Code Protocol.\r
   \r
-Copyright (c) 2006 - 2009, Intel Corporation                                                         \r
-All rights reserved. This program and the accompanying materials                          \r
-are licensed and made available under the terms and conditions of the BSD License         \r
-which accompanies this distribution.  The full text of the license may be found at        \r
-http://opensource.org/licenses/bsd-license.php                                            \r
-                                                                                          \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+  Copyright (c) 2006 - 2009, Intel Corporation                                                         \r
+  All rights reserved. This program and the accompanying materials                          \r
+  are licensed and made available under the terms and conditions of the BSD License         \r
+  which accompanies this distribution.  The full text of the license may be found at        \r
+  http://opensource.org/licenses/bsd-license.php                                            \r
+                                                                                            \r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
 **/\r
 \r
-\r
 #ifndef __DATA_HUB_STATUS_CODE_RECORD_H__\r
 #define __DATA_HUB_STATUS_CODE_RECORD_H__\r
 \r
+///\r
+/// Global ID used to identify a structure of type DATA_HUB_STATUS_CODE_DATA_RECORD\r
+///\r
 #define EFI_DATA_HUB_STATUS_CODE_RECORD_GUID \\r
   { \\r
     0xd083e94c, 0x6560, 0x42e4, {0xb6, 0xd4, 0x2d, 0xf7, 0x5a, 0xdf, 0x6a, 0x2a } \\r
   }\r
 \r
+///\r
+/// Data Hub data record that is used to store all the parameters passed into\r
+/// the ReportStatusCode() service of the EFI_STATUS_CODE_PROTOCOL.\r
+///\r
 typedef struct {\r
   ///\r
   /// Status Code type to be reported.\r
   ///\r
-  EFI_STATUS_CODE_TYPE  CodeType;\r
+  EFI_STATUS_CODE_TYPE   CodeType;\r
 \r
   ///\r
-  /// Valu information about the class and subclass is used to\r
+  /// Value 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
+  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
+  /// the system.  Valid instance numbers start with 1\r
   ///\r
-  UINT32                Instance;\r
+  UINT32                 Instance;\r
 \r
   ///\r
   /// Identify the caller.\r
   ///\r
-  EFI_GUID              CallerId;\r
+  EFI_GUID               CallerId;\r
 \r
   ///\r
   /// Additional status code data\r
   ///\r
-  EFI_STATUS_CODE_DATA  Data;\r
+  EFI_STATUS_CODE_DATA   Data;\r
 } DATA_HUB_STATUS_CODE_DATA_RECORD;\r
 \r
 extern EFI_GUID gEfiDataHubStatusCodeRecordGuid;\r