Use doxygen comment style for document entity such as struct, enum, variable that use /// but not //

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

1 files changed, 15 insertions, 12 deletions

diff --git a/MdePkg/Include/IndustryStandard/MemoryMappedConfigurationSpaceAccessTable.h b/MdePkg/Include/IndustryStandard/MemoryMappedConfigurationSpaceAccessTable.h
index 6539f19c25..2b26512213 100644
--- a/MdePkg/Include/IndustryStandard/MemoryMappedConfigurationSpaceAccessTable.h
+++ b/MdePkg/Include/IndustryStandard/MemoryMappedConfigurationSpaceAccessTable.h
@@ -20,11 +20,12 @@
 // Ensure proper structure formats

 //

 #pragma pack(1)

-//

-// Memory Mapped Configuration Space Access Table (MCFG)

-// This table is a basic description table header followed by

-// a number of base address allocation structures.

-//

+

+///

+/// Memory Mapped Configuration Space Access Table (MCFG)

+/// This table is a basic description table header followed by

+/// a number of base address allocation structures.

+///

 typedef struct {

   UINT64  BaseAddress;

   UINT16  PciSegmentGroupNumber;

@@ -32,17 +33,19 @@ typedef struct {
   UINT8   EndBusNumber;

   UINT32  Reserved;

 } EFI_ACPI_MEMORY_MAPPED_ENHANCED_CONFIGURATION_SPACE_BASE_ADDRESS_ALLOCATION_STRUCTURE;

-//

-// MCFG Table header definition.  The rest of the table 

-// must be defined in a platform specific manner.

-//

+

+///

+/// MCFG Table header definition.  The rest of the table 

+/// must be defined in a platform specific manner.

+///

 typedef struct {

   EFI_ACPI_DESCRIPTION_HEADER                       Header;

   UINT64                                            Reserved;

 } EFI_ACPI_MEMORY_MAPPED_CONFIGURATION_BASE_ADDRESS_TABLE_HEADER;

-//

-// MCFG Revision (defined in spec)

-//

+

+///

+/// MCFG Revision (defined in spec)

+///

 #define EFI_ACPI_MEMORY_MAPPED_CONFIGURATION_SPACE_ACCESS_TABLE_REVISION  0x01

 

 #pragma pack()