Use doxygen comment style for document entity such as struct, enum, variable that...

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

diff --git a/MdePkg/Include/Guid/Acpi.h b/MdePkg/Include/Guid/Acpi.h
index 91e24f1b22747699c13523fe2e7b4b8be765c6d9..ea616d3110c6186f990f741071bfbd7ac368bdbd 100644 (file)
--- a/MdePkg/Include/Guid/Acpi.h
+++ b/MdePkg/Include/Guid/Acpi.h
@@ -33,9 +33,9 @@
   }\r
 \r
 #define ACPI_10_TABLE_GUID     EFI_ACPI_10_TABLE_GUID\r
-//\r
-// ACPI 2.0 or newer tables should use EFI_ACPI_TABLE_GUID.\r
-//\r
+///\r
+/// ACPI 2.0 or newer tables should use EFI_ACPI_TABLE_GUID.\r
+///\r
 #define EFI_ACPI_20_TABLE_GUID EFI_ACPI_TABLE_GUID\r
 \r
 extern EFI_GUID gEfiAcpiTableGuid;\r

diff --git a/MdePkg/Include/Guid/AprioriFileName.h b/MdePkg/Include/Guid/AprioriFileName.h
index c2ee1b1d5536266b19db053bcdf6a6f69dee8b72..83d0d888ec7f363e36146362effc28f19aae81db 100644 (file)
--- a/MdePkg/Include/Guid/AprioriFileName.h
+++ b/MdePkg/Include/Guid/AprioriFileName.h
@@ -25,27 +25,19 @@
   { 0x1b45cc0a, 0x156a, 0x428a, { 0x62, 0XAF, 0x49, 0x86, 0x4d, 0xa0, 0xe6, 0xe6 } }\r
 \r
 \r
-/**\r
-   \r
-  This file must be of type EFI_FV_FILETYPE_FREEFORM and must\r
-  contain a single section of type EFI_SECTION_RAW. For details on\r
-  firmware volumes, firmware file types, and firmware file section\r
-  types.\r
-\r
-  @param FileNamesWithinVolume[]  An array of zero or more\r
-                                  EFI_GUID type entries that\r
-                                  match the file names of PEIM\r
-                                  modules in the same Firmware\r
-                                  Volume. The maximum number of\r
-                                  entries.\r
-\r
-  @param NumberOfModulesInVolume  Determined by the number of\r
-                                  modules in the FV.\r
-  \r
-**/\r
+\r
+///   \r
+///  This file must be of type EFI_FV_FILETYPE_FREEFORM and must\r
+///  contain a single section of type EFI_SECTION_RAW. For details on\r
+///  firmware volumes, firmware file types, and firmware file section\r
+///  types.\r
+///\r
 typedef struct {\r
+  ///\r
+  /// An array of zero or more EFI_GUID type entries that match the file names of PEIM\r
+  /// modules in the same Firmware Volume. The maximum number of entries. \r
+  ///\r
   EFI_GUID  FileNamesWithinVolume[1];\r
-// Optional list of file-names\r
 } PEI_APRIORI_FILE_CONTENTS;\r
 \r
 extern EFI_GUID gPeiAprioriFileNameGuid;\r

diff --git a/MdePkg/Include/Guid/FileInfo.h b/MdePkg/Include/Guid/FileInfo.h
index 31c9c739515428b4bf3d05267f3ac3791ec636df..a9f64666f3712542aede8de14f95e9717b669d4c 100644 (file)
--- a/MdePkg/Include/Guid/FileInfo.h
+++ b/MdePkg/Include/Guid/FileInfo.h
@@ -37,13 +37,13 @@ typedef struct {
   CHAR16    FileName[1];\r
 } EFI_FILE_INFO;\r
 \r
-//\r
-// The FileName field of the EFI_FILE_INFO data structure is variable length.\r
-// Whenever code needs to know the size of the EFI_FILE_INFO data structure, it needs to\r
-// be the size of the data structure without the FileName field.  The following macro\r
-// computes this size correctly no matter how big the FileName array is declared.\r
-// This is required to make the EFI_FILE_INFO data structure ANSI compilant.\r
-//\r
+///\r
+/// The FileName field of the EFI_FILE_INFO data structure is variable length.\r
+/// Whenever code needs to know the size of the EFI_FILE_INFO data structure, it needs to\r
+/// be the size of the data structure without the FileName field.  The following macro\r
+/// computes this size correctly no matter how big the FileName array is declared.\r
+/// This is required to make the EFI_FILE_INFO data structure ANSI compilant.\r
+///\r
 #define SIZE_OF_EFI_FILE_INFO EFI_FIELD_OFFSET (EFI_FILE_INFO, FileName)\r
 \r
 extern EFI_GUID gEfiFileInfoGuid;\r

diff --git a/MdePkg/Include/Guid/FileSystemInfo.h b/MdePkg/Include/Guid/FileSystemInfo.h
index a965fb503627d6d74b7d22cc0cd7dd8e355c24a5..6ed28b4f20f94b303e510887f08f4eacd85d31f5 100644 (file)
--- a/MdePkg/Include/Guid/FileSystemInfo.h
+++ b/MdePkg/Include/Guid/FileSystemInfo.h
@@ -29,13 +29,13 @@ typedef struct {
   CHAR16  VolumeLabel[1];\r
 } EFI_FILE_SYSTEM_INFO;\r
 \r
-//\r
-// The VolumeLabel field of the EFI_FILE_SYSTEM_INFO data structure is variable length.\r
-// Whenever code needs to know the size of the EFI_FILE_SYSTEM_INFO data structure, it needs\r
-// to be the size of the data structure without the VolumeLable field.  The following macro\r
-// computes this size correctly no matter how big the VolumeLable array is declared.\r
-// This is required to make the EFI_FILE_SYSTEM_INFO data structure ANSI compilant.\r
-//\r
+///\r
+/// The VolumeLabel field of the EFI_FILE_SYSTEM_INFO data structure is variable length.\r
+/// Whenever code needs to know the size of the EFI_FILE_SYSTEM_INFO data structure, it needs\r
+/// to be the size of the data structure without the VolumeLable field.  The following macro\r
+/// computes this size correctly no matter how big the VolumeLable array is declared.\r
+/// This is required to make the EFI_FILE_SYSTEM_INFO data structure ANSI compilant.\r
+///\r
 #define SIZE_OF_EFI_FILE_SYSTEM_INFO  EFI_FIELD_OFFSET (EFI_FILE_SYSTEM_INFO, VolumeLabel)\r
 \r
 extern EFI_GUID gEfiFileSystemInfoGuid;\r

diff --git a/MdePkg/Include/Guid/FirmwareFileSystem2.h b/MdePkg/Include/Guid/FirmwareFileSystem2.h
index 4a3adbb03dac6319db68bb3120b8fc81bd0ee070..383f24ff8f5d2380b24a9a674c09968d833d9f3c 100644 (file)
--- a/MdePkg/Include/Guid/FirmwareFileSystem2.h
+++ b/MdePkg/Include/Guid/FirmwareFileSystem2.h
@@ -18,18 +18,18 @@
 #ifndef __FIRMWARE_FILE_SYSTEM2_GUID_H__\r
 #define __FIRMWARE_FILE_SYSTEM2_GUID_H__\r
 \r
-// \r
-// The firmware volume header contains a data field for \r
-// the file system GUID\r
-// \r
+/// \r
+/// The firmware volume header contains a data field for \r
+/// the file system GUID\r
+/// \r
 #define EFI_FIRMWARE_FILE_SYSTEM2_GUID \\r
   { 0x8c8ce578, 0x8a3d, 0x4f1c, { 0x99, 0x35, 0x89, 0x61, 0x85, 0xc3, 0x2d, 0xd3 } }\r
 \r
-//\r
-// A Volume Top File (VTF) is a file that must be \r
-// located such that the last byte of the file is \r
-// also the last byte of the firmware volume\r
-// \r
+///\r
+/// A Volume Top File (VTF) is a file that must be \r
+/// located such that the last byte of the file is \r
+/// also the last byte of the firmware volume\r
+/// \r
 #define EFI_FFS_VOLUME_TOP_FILE_GUID \\r
   { 0x1BA0062E, 0xC779, 0x4582, { 0x85, 0x66, 0x33, 0x6A, 0xE8, 0xF7, 0x8F, 0x9 } }\r
 \r