Update comments

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

diff --git a/IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h b/IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h
index bab4aba8612429df67eb114856c3a23448dcef93..28a39a7e7d73d615e4c80fb12e743388c1686dd8 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h
+++ b/IntelFrameworkModulePkg/Include/Guid/StatusCodeDataTypeDebug.h
@@ -1,6 +1,6 @@
 /** @file\r
-  GUID used to pass DEBUG() macro information through the Status Code Protocol\r
-  and Status Code PPI\r
+  This file defines the GUID and data structure used to pass DEBUG() macro \r
+  information to the Status Code Protocol and Status Code PPI.\r
 \r
   Copyright (c) 2007 - 2009, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
@@ -16,22 +16,32 @@
 #ifndef _STATUS_CODE_DATA_TYPE_DEBUG_H_\r
 #define _STATUS_CODE_DATA_TYPE_DEBUG_H_\r
 \r
-//\r
-// Debug DataType defintions.\r
-//\r
-\r
+///\r
+/// Global ID used to identify a structure of type EFI_DEBUG_INFO\r
+///\r
 #define EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID \\r
-  { 0x9A4E9246, 0xD553, 0x11D5, { 0x87, 0xE2, 0x00, 0x06, 0x29, 0x45, 0xC3, 0xb9 } }\r
+  { \\r
+    0x9A4E9246, 0xD553, 0x11D5, { 0x87, 0xE2, 0x00, 0x06, 0x29, 0x45, 0xC3, 0xb9 } \\r
+  }\r
 \r
+///\r
+/// The maximum size of an EFI_DEBUG_INO structure\r
+///\r
 #define EFI_STATUS_CODE_DATA_MAX_SIZE 200\r
 \r
+///\r
+/// This structire contains the ErrorLevel passed into the DEBUG() macro followed \r
+/// by a 96-byte buffer that contains the variable argument list passed to the \r
+//  DEBUG() macro that has been converted to a BASE_LIST.  The 96-byte buffer is \r
+/// followed by a Null terminated ASCII string that is the Format string passed \r
+/// to the DEBUG() macro.  The maximum size of this structure is defined by \r
+/// EFI_STATUS_CODE_DATAS_MAX_SIZE.\r
+///\r
 typedef struct {\r
+  ///\r
+  /// The debug error level passed into a DEBUG() macro.\r
+  ///\r
   UINT32  ErrorLevel;\r
-  //\r
-  // 12 * sizeof (UINT64) area to store variable arguments for format in DEBUG string\r
-  //\r
-  // ascii DEBUG () Format string\r
-  //\r
 } EFI_DEBUG_INFO;\r
 \r
 extern EFI_GUID gEfiStatusCodeDataTypeDebugGuid;\r