From bf7ea00943f3b9e95a82bd2c231684f66f6f2b29 Mon Sep 17 00:00:00 2001
From: vanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Mon, 8 Dec 2008 06:59:18 +0000
Subject: [PATCH] added comments for some structures and apply for doxgen
 format

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6917 6f19259b-4bc3-4df7-8a09-765794883524
---
 MdePkg/Include/IndustryStandard/Mbr.h    |  8 ++++----
 MdePkg/Include/IndustryStandard/Sal.h    |  4 ++++
 MdePkg/Include/IndustryStandard/SmBios.h | 21 +++++++++++++++++++++
 3 files changed, 29 insertions(+), 4 deletions(-)

diff --git a/MdePkg/Include/IndustryStandard/Mbr.h b/MdePkg/Include/IndustryStandard/Mbr.h
index 8dd9d59f26..0f556f5adb 100644
--- a/MdePkg/Include/IndustryStandard/Mbr.h
+++ b/MdePkg/Include/IndustryStandard/Mbr.h
@@ -28,9 +28,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define MBR_SIZE                    512
 
 #pragma pack(1)
-//
-// MBR Partition Entry
-//
+///
+/// MBR Partition Entry
+///
 typedef struct {
   UINT8 BootIndicator;
   UINT8 StartHead;
@@ -45,7 +45,7 @@ typedef struct {
 } MBR_PARTITION_RECORD;
 
 ///
-/// MBR Partition table
+/// MBR Partition Table
 ///
 typedef struct {
   UINT8                 BootStrapCode[440];
diff --git a/MdePkg/Include/IndustryStandard/Sal.h b/MdePkg/Include/IndustryStandard/Sal.h
index df0c37090b..2199efe14c 100644
--- a/MdePkg/Include/IndustryStandard/Sal.h
+++ b/MdePkg/Include/IndustryStandard/Sal.h
@@ -729,10 +729,14 @@ typedef struct {
 #define PCI_BUS_OEM_ID_VALID_BIT_MASK           0x200
 #define PCI_BUS_OEM_DATA_STRUCT_VALID_BIT_MASK  0x400
 
+///
+/// Designated PCI Bus identifier
+///
 typedef struct {
   UINT8 BusNumber;
   UINT8 SegmentNumber;
 } PCI_BUS_ID;
+
 ///
 /// Definition of Platform PCI Bus Error Info Record
 ///
diff --git a/MdePkg/Include/IndustryStandard/SmBios.h b/MdePkg/Include/IndustryStandard/SmBios.h
index e44e239f6f..8e2f362cb3 100644
--- a/MdePkg/Include/IndustryStandard/SmBios.h
+++ b/MdePkg/Include/IndustryStandard/SmBios.h
@@ -44,6 +44,9 @@ typedef struct {
   UINT16  Handle;
 } SMBIOS_STRUCTURE;
 
+///
+/// String Number for a Null terminated string, 00h stands for no string available.
+///
 typedef UINT8 SMBIOS_TABLE_STRING;
 
 ///
@@ -97,6 +100,9 @@ typedef struct {
   UINT16                ContainedObjectHandles[1];
 } SMBIOS_TABLE_TYPE2;
 
+///
+/// Contained Element record
+///
 typedef struct {
   UINT8                 ContainedElementType;
   UINT8                 ContainedElementMinimum;
@@ -242,6 +248,9 @@ typedef struct {
   UINT8                 DevFuncNum;
 } SMBIOS_TABLE_TYPE9;
 
+///
+/// Device Item Entry
+///
 typedef struct {
   UINT8                 DeviceType;
   SMBIOS_TABLE_STRING   DescriptionString;
@@ -282,6 +291,9 @@ typedef struct {
   SMBIOS_TABLE_STRING   CurrentLanguages;
 } SMBIOS_TABLE_TYPE13;
 
+///
+/// Group Item Entry
+///
 typedef struct {
   UINT8                 ItemType;
   UINT16                ItemHandle;
@@ -296,6 +308,9 @@ typedef struct {
   GROUP_STRUCT          Group[1];
 } SMBIOS_TABLE_TYPE14;
 
+///
+/// Event Log Type Descriptors
+///
 typedef struct {
   UINT8                 LogType;
   UINT8                 DataFormatType;
@@ -603,6 +618,9 @@ typedef struct {
   UINT16                UpperThresholdNonRecoverable;
 } SMBIOS_TABLE_TYPE36;
 
+///
+/// Memory Channel Entry
+///
 typedef struct {
   UINT8                 DeviceLoad;
   UINT16                DeviceHandle;
@@ -653,6 +671,9 @@ typedef struct {
   UINT16                InputCurrentProbeHandle;
 } SMBIOS_TABLE_TYPE39;
 
+///
+/// Additional Information Entry Format 
+///
 typedef struct {                       
   UINT8                   EntryLength; 
   UINT16                  ReferencedHandle;