Grammatical and disclaimer changes (does not follow internal C coding stds.)

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

diff --git a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
index 54382f4ef33da0fb7a4afa148947865ff9ec3c2a..134567da4b5f3dc403a7f929dfe04f61d37664fb 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
+++ b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
@@ -1,33 +1,59 @@
-/**@file\r
-  GUID used to identify Data Hub records that originate from the Tiano \r
-  ReportStatusCode API.\r
+/** @file\r
+  GUID used to identify Data Hub records logged by Status Code Protocol.\r
   \r
-Copyright (c) 2006, 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
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+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
+#ifndef __DATA_HUB_STATUS_CODE_RECORD_H__\r
+#define __DATA_HUB_STATUS_CODE_RECORD_H__\r
 \r
-#ifndef __STATUS_CODE_H__\r
-#define __STATUS_CODE_H__\r
-\r
+///\r
+/// The 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
+/// The 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
-  EFI_STATUS_CODE_TYPE  CodeType;\r
-  EFI_STATUS_CODE_VALUE Value;\r
-  UINT32                Instance;\r
-  EFI_GUID              CallerId;\r
-  EFI_STATUS_CODE_DATA  Data;\r
+  ///\r
+  /// Status Code type to be reported.\r
+  ///\r
+  EFI_STATUS_CODE_TYPE   CodeType;\r
+\r
+  ///\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
+  ///\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