diff options
| author | klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-08-14 04:11:35 +0000 |
|---|---|---|
| committer | klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-08-14 04:11:35 +0000 |
| commit | 06889842319d8fc9dd46a4b5dd1804df02e9cece (patch) | |
| tree | 759ed8735c150bfeedb28af605ed9f3318140e8b | |
| parent | fc30687f39436f5b5e00396a5161b30b70db8277 (diff) | |
| download | edk2-06889842319d8fc9dd46a4b5dd1804df02e9cece.tar.gz edk2-06889842319d8fc9dd46a4b5dd1804df02e9cece.tar.bz2 edk2-06889842319d8fc9dd46a4b5dd1804df02e9cece.zip | |
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@5648 6f19259b-4bc3-4df7-8a09-765794883524
| -rw-r--r-- | MdePkg/Include/Ppi/CpuIo.h | 20 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/FirmwareVolume.h | 10 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/LoadImage.h | 2 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/PciCfg2.h | 12 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/SecPlatformInformation.h | 10 | ||||
| -rw-r--r-- | MdePkg/Include/Ppi/TemporaryRamSupport.h | 2 |
6 files changed, 28 insertions, 28 deletions
diff --git a/MdePkg/Include/Ppi/CpuIo.h b/MdePkg/Include/Ppi/CpuIo.h index 1cc6e989ba..cdb83a92d4 100644 --- a/MdePkg/Include/Ppi/CpuIo.h +++ b/MdePkg/Include/Ppi/CpuIo.h @@ -28,11 +28,11 @@ typedef struct _EFI_PEI_CPU_IO_PPI EFI_PEI_CPU_IO_PPI;
-//
-// *******************************************************
-// EFI_PEI_CPU_IO_PPI_WIDTH
-// *******************************************************
-//
+///
+/// *******************************************************
+/// EFI_PEI_CPU_IO_PPI_WIDTH
+/// *******************************************************
+///
typedef enum {
EfiPeiCpuIoWidthUint8,
EfiPeiCpuIoWidthUint16,
@@ -74,11 +74,11 @@ EFI_STATUS IN OUT VOID *Buffer
);
-//
-// *******************************************************
-// EFI_PEI_CPU_IO_PPI_ACCESS
-// *******************************************************
-//
+///
+/// *******************************************************
+/// EFI_PEI_CPU_IO_PPI_ACCESS
+/// *******************************************************
+///
typedef struct {
EFI_PEI_CPU_IO_PPI_IO_MEM Read;
EFI_PEI_CPU_IO_PPI_IO_MEM Write;
diff --git a/MdePkg/Include/Ppi/FirmwareVolume.h b/MdePkg/Include/Ppi/FirmwareVolume.h index 5a8f87c49b..1bc96796ab 100644 --- a/MdePkg/Include/Ppi/FirmwareVolume.h +++ b/MdePkg/Include/Ppi/FirmwareVolume.h @@ -19,11 +19,11 @@ #ifndef __FIRMWARE_VOLUME_PPI_H__
#define __FIRMWARE_VOLUME_PPI_H__
-//
-// The GUID for this PPI is the same as the firmware volume format GUID.
-// can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for a user-defined format. The
-// EFI_FIRMWARE_FILE_SYSTEM2_GUID is the PI Firmware Volume format.
-//
+///
+/// The GUID for this PPI is the same as the firmware volume format GUID.
+/// can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for a user-defined format. The
+/// EFI_FIRMWARE_FILE_SYSTEM2_GUID is the PI Firmware Volume format.
+///
typedef struct _EFI_PEI_FIRMWARE_VOLUME_PPI EFI_PEI_FIRMWARE_VOLUME_PPI;
diff --git a/MdePkg/Include/Ppi/LoadImage.h b/MdePkg/Include/Ppi/LoadImage.h index 1c180a70aa..5d07fd96b8 100644 --- a/MdePkg/Include/Ppi/LoadImage.h +++ b/MdePkg/Include/Ppi/LoadImage.h @@ -26,7 +26,7 @@ typedef struct _EFI_PEI_LOADED_IMAGE_PPI EFI_PEI_LOADED_IMAGE_PPI;
-/*
+/**
@par Ppi Description:
This interface is installed by the PEI Dispatcher after the image has been
loaded and after all security checks have been performed,
diff --git a/MdePkg/Include/Ppi/PciCfg2.h b/MdePkg/Include/Ppi/PciCfg2.h index d44ee09ef0..b741cb7279 100644 --- 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) | \
((reg) < 256 ? (reg) : ((UINT64)(reg) << 32)));
-//
-// EFI_PEI_PCI_CFG_PPI_WIDTH
-//
+///
+/// EFI_PEI_PCI_CFG_PPI_WIDTH
+///
typedef enum {
EfiPeiPciCfgWidthUint8 = 0,
EfiPeiPciCfgWidthUint16 = 1,
@@ -48,9 +48,9 @@ typedef enum { EfiPeiPciCfgWidthMaximum
} EFI_PEI_PCI_CFG_PPI_WIDTH;
-//
-// EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS
-//
+///
+/// EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS
+///
typedef struct {
UINT8 Register;
UINT8 Function;
diff --git a/MdePkg/Include/Ppi/SecPlatformInformation.h b/MdePkg/Include/Ppi/SecPlatformInformation.h index b1651129b7..fc5c366869 100644 --- 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;
-//
-// EFI_HEALTH_FLAGS
-// Contains information generated by microcode, hardware, and/or the Itanium
-// processor PAL code about the state of the processor upon reset.
-//
+///
+/// EFI_HEALTH_FLAGS
+/// Contains information generated by microcode, hardware, and/or the Itanium
+/// processor PAL code about the state of the processor upon reset.
+///
typedef union {
struct {
UINT32 Status : 2;
diff --git a/MdePkg/Include/Ppi/TemporaryRamSupport.h b/MdePkg/Include/Ppi/TemporaryRamSupport.h index 26afa7f62b..76e7c923ee 100644 --- 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} }
-/*
+/**
This service of the TEMPORARY_RAM_SUPPORT_PPI that migrates temporary RAM into
permanent memory.
|