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@5648 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Ppi/CpuIo.h b/MdePkg/Include/Ppi/CpuIo.h
index 1cc6e989ba5c7039dbca800deb70590694e28055..cdb83a92d431a0939e496ebd0f5b2cf49ac523d1 100644 (file)
--- a/MdePkg/Include/Ppi/CpuIo.h
+++ b/MdePkg/Include/Ppi/CpuIo.h
@@ -28,11 +28,11 @@
 \r
 typedef struct _EFI_PEI_CPU_IO_PPI  EFI_PEI_CPU_IO_PPI;\r
 \r
-//\r
-// *******************************************************\r
-// EFI_PEI_CPU_IO_PPI_WIDTH\r
-// *******************************************************\r
-//\r
+///\r
+/// *******************************************************\r
+/// EFI_PEI_CPU_IO_PPI_WIDTH\r
+/// *******************************************************\r
+///\r
 typedef enum {\r
   EfiPeiCpuIoWidthUint8,\r
   EfiPeiCpuIoWidthUint16,\r
@@ -74,11 +74,11 @@ EFI_STATUS
   IN  OUT VOID                          *Buffer\r
   );\r
 \r
-//\r
-// *******************************************************\r
-// EFI_PEI_CPU_IO_PPI_ACCESS\r
-// *******************************************************\r
-//\r
+///\r
+/// *******************************************************\r
+/// EFI_PEI_CPU_IO_PPI_ACCESS\r
+/// *******************************************************\r
+///\r
 typedef struct {\r
   EFI_PEI_CPU_IO_PPI_IO_MEM Read;\r
   EFI_PEI_CPU_IO_PPI_IO_MEM Write;\r

diff --git a/MdePkg/Include/Ppi/FirmwareVolume.h b/MdePkg/Include/Ppi/FirmwareVolume.h
index 5a8f87c49bdf96fa0c65bd32de649f34c40fd191..1bc96796abef01eb8c83ee8ffef844aabd0790a1 100644 (file)
--- a/MdePkg/Include/Ppi/FirmwareVolume.h
+++ b/MdePkg/Include/Ppi/FirmwareVolume.h
@@ -19,11 +19,11 @@
 #ifndef __FIRMWARE_VOLUME_PPI_H__\r
 #define __FIRMWARE_VOLUME_PPI_H__\r
 \r
-//\r
-// The GUID for this PPI is the same as the firmware volume format GUID.\r
-// can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for a user-defined format. The\r
-// EFI_FIRMWARE_FILE_SYSTEM2_GUID is the PI Firmware Volume format.\r
-// \r
+///\r
+/// The GUID for this PPI is the same as the firmware volume format GUID.\r
+/// can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for a user-defined format. The\r
+/// EFI_FIRMWARE_FILE_SYSTEM2_GUID is the PI Firmware Volume format.\r
+/// \r
 \r
 typedef struct _EFI_PEI_FIRMWARE_VOLUME_PPI   EFI_PEI_FIRMWARE_VOLUME_PPI;\r
 \r

diff --git a/MdePkg/Include/Ppi/LoadImage.h b/MdePkg/Include/Ppi/LoadImage.h
index 1c180a70aaa484c9f43227a67a4a1d02c3a258be..5d07fd96b8e6eccbe56b230ded405d836701d52b 100644 (file)
--- a/MdePkg/Include/Ppi/LoadImage.h
+++ b/MdePkg/Include/Ppi/LoadImage.h
@@ -26,7 +26,7 @@
 \r
 typedef struct _EFI_PEI_LOADED_IMAGE_PPI  EFI_PEI_LOADED_IMAGE_PPI;\r
 \r
-/*\r
+/**\r
   @par Ppi Description:\r
   This interface is installed by the PEI Dispatcher after the image has been\r
   loaded and after all security checks have been performed, \r

diff --git a/MdePkg/Include/Ppi/PciCfg2.h b/MdePkg/Include/Ppi/PciCfg2.h
index d44ee09ef00031f9f7f98a2abe9d08c706dfb528..b741cb72797a684458725561a387dd1acaab1562 100644 (file)
--- a/MdePkg/Include/Ppi/PciCfg2.h
+++ b/MdePkg/Include/Ppi/PciCfg2.h
@@ -37,9 +37,9 @@ typedef struct _EFI_PEI_PCI_CFG2_PPI   EFI_PEI_PCI_CFG2_PPI;
   ((func) << 8) | \\r
   ((reg) < 256 ? (reg) : ((UINT64)(reg) << 32)));\r
 \r
-//\r
-// EFI_PEI_PCI_CFG_PPI_WIDTH\r
-//\r
+///\r
+/// EFI_PEI_PCI_CFG_PPI_WIDTH\r
+///\r
 typedef enum {\r
   EfiPeiPciCfgWidthUint8  = 0,\r
   EfiPeiPciCfgWidthUint16 = 1,\r
@@ -48,9 +48,9 @@ typedef enum {
   EfiPeiPciCfgWidthMaximum\r
 } EFI_PEI_PCI_CFG_PPI_WIDTH;\r
 \r
-//\r
-// EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS\r
-//\r
+///\r
+/// EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS\r
+///\r
 typedef struct {\r
   UINT8   Register;\r
   UINT8   Function;\r

diff --git a/MdePkg/Include/Ppi/SecPlatformInformation.h b/MdePkg/Include/Ppi/SecPlatformInformation.h
index b1651129b7686c12b0699d64e8c1e2eee670a9c8..fc5c366869132002bb0eea2942a8aaf858a43fad 100644 (file)
--- a/MdePkg/Include/Ppi/SecPlatformInformation.h
+++ b/MdePkg/Include/Ppi/SecPlatformInformation.h
@@ -32,11 +32,11 @@
 typedef struct _EFI_SEC_PLATFORM_INFORMATION_PPI EFI_SEC_PLATFORM_INFORMATION_PPI;\r
 \r
 \r
-//\r
-// EFI_HEALTH_FLAGS\r
-// Contains information generated by microcode, hardware, and/or the Itanium\r
-// processor PAL code about the state of the processor upon reset.\r
-//\r
+///\r
+/// EFI_HEALTH_FLAGS\r
+/// Contains information generated by microcode, hardware, and/or the Itanium\r
+/// processor PAL code about the state of the processor upon reset.\r
+///\r
 typedef union {\r
   struct {\r
     UINT32   Status                   : 2;\r

diff --git a/MdePkg/Include/Ppi/TemporaryRamSupport.h b/MdePkg/Include/Ppi/TemporaryRamSupport.h
index 26afa7f62b21f9d718fd57d47f22d49e29b6a404..76e7c923eef91e2af75c7002ee585d9bcd64cd37 100644 (file)
--- a/MdePkg/Include/Ppi/TemporaryRamSupport.h
+++ b/MdePkg/Include/Ppi/TemporaryRamSupport.h
@@ -24,7 +24,7 @@
   { 0xdbe23aa9, 0xa345, 0x4b97, {0x85, 0xb6, 0xb2, 0x26, 0xf1, 0x61, 0x73, 0x89} }\r
 \r
 \r
-/*\r
+/**\r
   This service of the TEMPORARY_RAM_SUPPORT_PPI that migrates temporary RAM into\r
   permanent memory.\r
 \r