mirror of https://github.com/acidanthera/audk.git
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
This commit is contained in:
parent
fc30687f39
commit
0688984231
|
@ -28,11 +28,11 @@
|
||||||
|
|
||||||
typedef struct _EFI_PEI_CPU_IO_PPI EFI_PEI_CPU_IO_PPI;
|
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 {
|
typedef enum {
|
||||||
EfiPeiCpuIoWidthUint8,
|
EfiPeiCpuIoWidthUint8,
|
||||||
EfiPeiCpuIoWidthUint16,
|
EfiPeiCpuIoWidthUint16,
|
||||||
|
@ -74,11 +74,11 @@ EFI_STATUS
|
||||||
IN OUT VOID *Buffer
|
IN OUT VOID *Buffer
|
||||||
);
|
);
|
||||||
|
|
||||||
//
|
///
|
||||||
// *******************************************************
|
/// *******************************************************
|
||||||
// EFI_PEI_CPU_IO_PPI_ACCESS
|
/// EFI_PEI_CPU_IO_PPI_ACCESS
|
||||||
// *******************************************************
|
/// *******************************************************
|
||||||
//
|
///
|
||||||
typedef struct {
|
typedef struct {
|
||||||
EFI_PEI_CPU_IO_PPI_IO_MEM Read;
|
EFI_PEI_CPU_IO_PPI_IO_MEM Read;
|
||||||
EFI_PEI_CPU_IO_PPI_IO_MEM Write;
|
EFI_PEI_CPU_IO_PPI_IO_MEM Write;
|
||||||
|
|
|
@ -19,11 +19,11 @@
|
||||||
#ifndef __FIRMWARE_VOLUME_PPI_H__
|
#ifndef __FIRMWARE_VOLUME_PPI_H__
|
||||||
#define __FIRMWARE_VOLUME_PPI_H__
|
#define __FIRMWARE_VOLUME_PPI_H__
|
||||||
|
|
||||||
//
|
///
|
||||||
// The GUID for this PPI is the same as the firmware volume format GUID.
|
/// 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
|
/// 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.
|
/// EFI_FIRMWARE_FILE_SYSTEM2_GUID is the PI Firmware Volume format.
|
||||||
//
|
///
|
||||||
|
|
||||||
typedef struct _EFI_PEI_FIRMWARE_VOLUME_PPI EFI_PEI_FIRMWARE_VOLUME_PPI;
|
typedef struct _EFI_PEI_FIRMWARE_VOLUME_PPI EFI_PEI_FIRMWARE_VOLUME_PPI;
|
||||||
|
|
||||||
|
|
|
@ -26,7 +26,7 @@
|
||||||
|
|
||||||
typedef struct _EFI_PEI_LOADED_IMAGE_PPI EFI_PEI_LOADED_IMAGE_PPI;
|
typedef struct _EFI_PEI_LOADED_IMAGE_PPI EFI_PEI_LOADED_IMAGE_PPI;
|
||||||
|
|
||||||
/*
|
/**
|
||||||
@par Ppi Description:
|
@par Ppi Description:
|
||||||
This interface is installed by the PEI Dispatcher after the image has been
|
This interface is installed by the PEI Dispatcher after the image has been
|
||||||
loaded and after all security checks have been performed,
|
loaded and after all security checks have been performed,
|
||||||
|
|
|
@ -37,9 +37,9 @@ typedef struct _EFI_PEI_PCI_CFG2_PPI EFI_PEI_PCI_CFG2_PPI;
|
||||||
((func) << 8) | \
|
((func) << 8) | \
|
||||||
((reg) < 256 ? (reg) : ((UINT64)(reg) << 32)));
|
((reg) < 256 ? (reg) : ((UINT64)(reg) << 32)));
|
||||||
|
|
||||||
//
|
///
|
||||||
// EFI_PEI_PCI_CFG_PPI_WIDTH
|
/// EFI_PEI_PCI_CFG_PPI_WIDTH
|
||||||
//
|
///
|
||||||
typedef enum {
|
typedef enum {
|
||||||
EfiPeiPciCfgWidthUint8 = 0,
|
EfiPeiPciCfgWidthUint8 = 0,
|
||||||
EfiPeiPciCfgWidthUint16 = 1,
|
EfiPeiPciCfgWidthUint16 = 1,
|
||||||
|
@ -48,9 +48,9 @@ typedef enum {
|
||||||
EfiPeiPciCfgWidthMaximum
|
EfiPeiPciCfgWidthMaximum
|
||||||
} EFI_PEI_PCI_CFG_PPI_WIDTH;
|
} EFI_PEI_PCI_CFG_PPI_WIDTH;
|
||||||
|
|
||||||
//
|
///
|
||||||
// EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS
|
/// EFI_PEI_PCI_CFG_PPI_PCI_ADDRESS
|
||||||
//
|
///
|
||||||
typedef struct {
|
typedef struct {
|
||||||
UINT8 Register;
|
UINT8 Register;
|
||||||
UINT8 Function;
|
UINT8 Function;
|
||||||
|
|
|
@ -32,11 +32,11 @@
|
||||||
typedef struct _EFI_SEC_PLATFORM_INFORMATION_PPI EFI_SEC_PLATFORM_INFORMATION_PPI;
|
typedef struct _EFI_SEC_PLATFORM_INFORMATION_PPI EFI_SEC_PLATFORM_INFORMATION_PPI;
|
||||||
|
|
||||||
|
|
||||||
//
|
///
|
||||||
// EFI_HEALTH_FLAGS
|
/// EFI_HEALTH_FLAGS
|
||||||
// Contains information generated by microcode, hardware, and/or the Itanium
|
/// Contains information generated by microcode, hardware, and/or the Itanium
|
||||||
// processor PAL code about the state of the processor upon reset.
|
/// processor PAL code about the state of the processor upon reset.
|
||||||
//
|
///
|
||||||
typedef union {
|
typedef union {
|
||||||
struct {
|
struct {
|
||||||
UINT32 Status : 2;
|
UINT32 Status : 2;
|
||||||
|
|
|
@ -24,7 +24,7 @@
|
||||||
{ 0xdbe23aa9, 0xa345, 0x4b97, {0x85, 0xb6, 0xb2, 0x26, 0xf1, 0x61, 0x73, 0x89} }
|
{ 0xdbe23aa9, 0xa345, 0x4b97, {0x85, 0xb6, 0xb2, 0x26, 0xf1, 0x61, 0x73, 0x89} }
|
||||||
|
|
||||||
|
|
||||||
/*
|
/**
|
||||||
This service of the TEMPORARY_RAM_SUPPORT_PPI that migrates temporary RAM into
|
This service of the TEMPORARY_RAM_SUPPORT_PPI that migrates temporary RAM into
|
||||||
permanent memory.
|
permanent memory.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue