Add comments for IntelFrameworkModulePkg Header file.

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

diff --git a/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h b/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h
index 4f623b5de6dcbea69d2a28687b8f5684731d1f3c..fcc7a0d72e11cc19774ba51437ad13eb209be605 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h
+++ b/IntelFrameworkModulePkg/Include/Guid/MemoryStatusCodeRecord.h
@@ -1,7 +1,7 @@
 /** @file\r
   GUID used to identify status code records HOB that originate from the PEI status code    \r
   \r
-Copyright (c) 2006, Intel Corporation                                                         \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
@@ -30,15 +30,28 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
                   +---------------- MaxRecordsNumber----------------------+\r
 **/\r
 typedef struct {\r
-  UINT16                  PacketIndex;          // Index of the Packet.\r
-  UINT16                  RecordIndex;          // Index of record in the packet.\r
-  UINT32                  MaxRecordsNumber;     // Max number of records in the packet.\r
+  UINT16                  PacketIndex;          ///< Index of the Packet.\r
+  UINT16                  RecordIndex;          ///< Index of record in the packet.\r
+  UINT32                  MaxRecordsNumber;     ///< Max number of records in the packet.\r
 } MEMORY_STATUSCODE_PACKET_HEADER;\r
 \r
 typedef struct {\r
-  EFI_STATUS_CODE_TYPE    CodeType;\r
-  EFI_STATUS_CODE_VALUE   Value;\r
-  UINT32                  Instance;\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
 } MEMORY_STATUSCODE_RECORD;\r
 \r
 \r