sravan/system76-edk2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix doxygen issue:

Browse Source 
1) comment for structure should be in doxygen format, such as /// , /**, /*!
2) comment for data field of structure should in doxygen format.
3) should not exist blank between ") (" when declaring a type of function point.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5364 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2
2008-06-24 07:14:18 +00:00
parent dc53faa3a2
commit 8b13229b46
98 changed files with 736 additions and 734 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
MdePkg/Include/Uefi/UefiBaseType.h
View File

@ -18,10 +18,11 @@
#include "Base.h"
//
// Basical data type definitions introduced in UEFI.
//
///
/// Basical data type definitions introduced in UEFI.
///
typedef GUID EFI_GUID;
///
/// Function return status for EFI API
///
@ -148,9 +149,9 @@ typedef union {
(EFI_SIGNATURE_32 (A, B, C, D) | ((UINT64) (EFI_SIGNATURE_32 (E, F, G, H)) << 32))
//
// Returns the byte offset to a field within a structure
//
///
/// Returns the byte offset to a field within a structure
///
#define EFI_FIELD_OFFSET(TYPE,Field) ((UINTN)(&(((TYPE *) 0)->Field)))
//

25
MdePkg/Include/Uefi/UefiGpt.h
View File

@ -17,15 +17,16 @@
#define PRIMARY_PART_HEADER_LBA 1
//
// EFI Partition Table Signature: "EFI PART"
//
///
/// EFI Partition Table Signature: "EFI PART"
///
#define EFI_PTAB_HEADER_ID 0x5452415020494645ULL
#pragma pack(1)
//
// GPT Partition Table Header
//
///
/// GPT Partition Table Header
///
typedef struct {
EFI_TABLE_HEADER Header;
EFI_LBA MyLBA;
@ -39,9 +40,9 @@ typedef struct {
UINT32 PartitionEntryArrayCRC32;
} EFI_PARTITION_TABLE_HEADER;
//
// GPT Partition Entry
//
///
/// GPT Partition Entry
///
typedef struct {
EFI_GUID PartitionTypeGUID;
EFI_GUID UniquePartitionGUID;
@ -51,9 +52,9 @@ typedef struct {
CHAR16 PartitionName[36];
} EFI_PARTITION_ENTRY;
//
// GPT Partition Entry Status
//
///
/// GPT Partition Entry Status
///
typedef struct {
BOOLEAN OutOfRange;
BOOLEAN Overlap;

52
MdePkg/Include/Uefi/UefiInternalFormRepresentation.h
View File

@ -41,9 +41,9 @@ typedef UINT32 EFI_HII_FONT_STYLE;
#pragma pack(1)
//
// HII package list
//
///
/// HII package list
///
typedef struct {
EFI_GUID PackageListGuid;
UINT32 PackageLength;
@ -1391,22 +1391,24 @@ typedef struct {
UINT16 AffectedAttribute;
} EFI_KEY_DESCRIPTOR;
//
// A key which is affected by all the standard shift modifiers.
// Most keys would be expected to have this bit active.
//
///
/// A key which is affected by all the standard shift modifiers.
/// Most keys would be expected to have this bit active.
///
#define EFI_AFFECTED_BY_STANDARD_SHIFT 0x0001
//
// This key is affected by the caps lock so that if a keyboard driver
// would need to disambiguate between a key which had a "1" defined
// versus a "a" character. Having this bit turned on would tell
// the keyboard driver to use the appropriate shifted state or not.
//
///
/// This key is affected by the caps lock so that if a keyboard driver
/// would need to disambiguate between a key which had a "1" defined
/// versus a "a" character. Having this bit turned on would tell
/// the keyboard driver to use the appropriate shifted state or not.
///
#define EFI_AFFECTED_BY_CAPS_LOCK 0x0002
//
// Similar to the case of CAPS lock, if this bit is active, the key
// is affected by the num lock being turned on.
//
///
/// Similar to the case of CAPS lock, if this bit is active, the key
/// is affected by the num lock being turned on.
///
#define EFI_AFFECTED_BY_NUM_LOCK 0x0004
typedef struct {
@ -1493,14 +1495,14 @@ typedef struct {
//
// References to string tokens must use this macro to enable scanning for
// token usages.
//
//
// STRING_TOKEN is not defined in UEFI specification. But it is placed
// here for the easy access by C files and VFR source files.
//
///
/// References to string tokens must use this macro to enable scanning for
/// token usages.
///
///
/// STRING_TOKEN is not defined in UEFI specification. But it is placed
/// here for the easy access by C files and VFR source files.
///
#define STRING_TOKEN(t) t
#endif

28
MdePkg/Include/Uefi/UefiMultiPhase.h
View File

@ -17,9 +17,9 @@
#include <ProcessorBind.h>
//
// Enumeration of memory types introduced in UEFI.
//
///
/// Enumeration of memory types introduced in UEFI.
///
typedef enum {
EfiReservedMemoryType,
EfiLoaderCode,
@ -39,9 +39,9 @@ typedef enum {
} EFI_MEMORY_TYPE;
//
// Data structure that precedes all of the standard EFI table types.
//
///
/// Data structure that precedes all of the standard EFI table types.
///
typedef struct {
UINT64 Signature;
UINT32 Revision;
@ -50,22 +50,20 @@ typedef struct {
UINT32 Reserved;
} EFI_TABLE_HEADER;
//
// Attributes of variable.
//
///
/// Attributes of variable.
///
#define EFI_VARIABLE_NON_VOLATILE 0x00000001
#define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002
#define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004
#define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x00000008
//
// This attribute is identified by the mnemonic 'HR'
// elsewhere in this specification.
//
///
/// This attribute is identified by the mnemonic 'HR'
/// elsewhere in this specification.
///
#define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS 0x00000010
//
// _WIN_CERTIFICATE.wCertificateType
//

212
MdePkg/Include/Uefi/UefiPxe.h
View File

@ -31,14 +31,14 @@
((PXE_UINT32) (a) & 0xFF) \
)
//
// UNDI ROM ID and devive ID signature
//
///
/// UNDI ROM ID and devive ID signature
///
#define PXE_BUSTYPE_PXE PXE_BUSTYPE ('!', 'P', 'X', 'E')
//
// BUS ROM ID signatures
//
///
/// BUS ROM ID signatures
///
#define PXE_BUSTYPE_PCI PXE_BUSTYPE ('P', 'C', 'I', 'R')
#define PXE_BUSTYPE_PC_CARD PXE_BUSTYPE ('P', 'C', 'C', 'R')
#define PXE_BUSTYPE_USB PXE_BUSTYPE ('U', 'S', 'B', 'R')
@ -77,9 +77,9 @@ typedef UINT16 PXE_UINT16;
typedef UINT32 PXE_UINT32;
typedef UINTN PXE_UINTN;
//
// typedef unsigned long PXE_UINT64;
//
///
/// typedef unsigned long PXE_UINT64;
///
typedef UINT64 PXE_UINT64;
typedef PXE_UINT8 PXE_BOOL;
@ -88,99 +88,99 @@ typedef PXE_UINT8 PXE_BOOL;
typedef PXE_UINT16 PXE_OPCODE;
//
// Return UNDI operational state.
//
///
/// Return UNDI operational state.
///
#define PXE_OPCODE_GET_STATE 0x0000
//
// Change UNDI operational state from Stopped to Started.
//
///
/// Change UNDI operational state from Stopped to Started.
///
#define PXE_OPCODE_START 0x0001
//
// Change UNDI operational state from Started to Stopped.
//
///
/// Change UNDI operational state from Started to Stopped.
///
#define PXE_OPCODE_STOP 0x0002
//
// Get UNDI initialization information.
//
///
/// Get UNDI initialization information.
///
#define PXE_OPCODE_GET_INIT_INFO 0x0003
//
// Get NIC configuration information.
//
///
/// Get NIC configuration information.
///
#define PXE_OPCODE_GET_CONFIG_INFO 0x0004
//
// Changed UNDI operational state from Started to Initialized.
//
///
/// Changed UNDI operational state from Started to Initialized.
///
#define PXE_OPCODE_INITIALIZE 0x0005
//
// Re-initialize the NIC H/W.
//
///
/// Re-initialize the NIC H/W.
///
#define PXE_OPCODE_RESET 0x0006
//
// Change the UNDI operational state from Initialized to Started.
//
///
/// Change the UNDI operational state from Initialized to Started.
///
#define PXE_OPCODE_SHUTDOWN 0x0007
//
// Read & change state of external interrupt enables.
//
///
/// Read & change state of external interrupt enables.
///
#define PXE_OPCODE_INTERRUPT_ENABLES 0x0008
//
// Read & change state of packet receive filters.
//
///
/// Read & change state of packet receive filters.
///
#define PXE_OPCODE_RECEIVE_FILTERS 0x0009
//
// Read & change station MAC address.
//
///
/// Read & change station MAC address.
///
#define PXE_OPCODE_STATION_ADDRESS 0x000A
//
// Read traffic statistics.
//
///
/// Read traffic statistics.
///
#define PXE_OPCODE_STATISTICS 0x000B
//
// Convert multicast IP address to multicast MAC address.
//
///
/// Convert multicast IP address to multicast MAC address.
///
#define PXE_OPCODE_MCAST_IP_TO_MAC 0x000C
//
// Read or change non-volatile storage on the NIC.
//
///
/// Read or change non-volatile storage on the NIC.
///
#define PXE_OPCODE_NVDATA 0x000D
//
// Get & clear interrupt status.
//
///
/// Get & clear interrupt status.
///
#define PXE_OPCODE_GET_STATUS 0x000E
//
// Fill media header in packet for transmit.
//
///
/// Fill media header in packet for transmit.
///
#define PXE_OPCODE_FILL_HEADER 0x000F
//
// Transmit packet(s).
//
///
/// Transmit packet(s).
///
#define PXE_OPCODE_TRANSMIT 0x0010
//
// Receive packet.
//
///
/// Receive packet.
///
#define PXE_OPCODE_RECEIVE 0x0011
//
// Last valid PXE UNDI OpCode number.
//
///
/// Last valid PXE UNDI OpCode number.
///
#define PXE_OPCODE_LAST_VALID 0x0011
typedef PXE_UINT16 PXE_OPFLAGS;
@ -245,28 +245,28 @@ typedef PXE_UINT16 PXE_OPFLAGS;
#define PXE_OPFLAGS_INTERRUPT_DISABLE 0x4000
#define PXE_OPFLAGS_INTERRUPT_READ 0x0000
//
// Enable receive interrupts. An external interrupt will be generated
// after a complete non-error packet has been received.
//
///
/// Enable receive interrupts. An external interrupt will be generated
/// after a complete non-error packet has been received.
///
#define PXE_OPFLAGS_INTERRUPT_RECEIVE 0x0001
//
// Enable transmit interrupts. An external interrupt will be generated
// after a complete non-error packet has been transmitted.
//
///
/// Enable transmit interrupts. An external interrupt will be generated
/// after a complete non-error packet has been transmitted.
///
#define PXE_OPFLAGS_INTERRUPT_TRANSMIT 0x0002
//
// Enable command interrupts. An external interrupt will be generated
// when command execution stops.
//
///
/// Enable command interrupts. An external interrupt will be generated
/// when command execution stops.
///
#define PXE_OPFLAGS_INTERRUPT_COMMAND 0x0004
//
// Generate software interrupt. Setting this bit generates an external
// interrupt, if it is supported by the hardware.
//
///
/// Generate software interrupt. Setting this bit generates an external
/// interrupt, if it is supported by the hardware.
///
#define PXE_OPFLAGS_INTERRUPT_SOFTWARE 0x0008
//
@ -282,40 +282,40 @@ typedef PXE_UINT16 PXE_OPFLAGS;
#define PXE_OPFLAGS_RECEIVE_FILTER_DISABLE 0x4000
#define PXE_OPFLAGS_RECEIVE_FILTER_READ 0x0000
//
// To reset the contents of the multicast MAC address filter list,
// set this OpFlag:
//
///
/// To reset the contents of the multicast MAC address filter list,
/// set this OpFlag:
///
#define PXE_OPFLAGS_RECEIVE_FILTER_RESET_MCAST_LIST 0x2000
//
// Enable unicast packet receiving. Packets sent to the current station
// MAC address will be received.
//
///
/// Enable unicast packet receiving. Packets sent to the current station
/// MAC address will be received.
///
#define PXE_OPFLAGS_RECEIVE_FILTER_UNICAST 0x0001
//
// Enable broadcast packet receiving. Packets sent to the broadcast
// MAC address will be received.
//
///
/// Enable broadcast packet receiving. Packets sent to the broadcast
/// MAC address will be received.
///
#define PXE_OPFLAGS_RECEIVE_FILTER_BROADCAST 0x0002
//
// Enable filtered multicast packet receiving. Packets sent to any
// of the multicast MAC addresses in the multicast MAC address filter
// list will be received. If the filter list is empty, no multicast
//
///
/// Enable filtered multicast packet receiving. Packets sent to any
/// of the multicast MAC addresses in the multicast MAC address filter
/// list will be received. If the filter list is empty, no multicast
///
#define PXE_OPFLAGS_RECEIVE_FILTER_FILTERED_MULTICAST 0x0004
//
// Enable promiscuous packet receiving. All packets will be received.
//
///
/// Enable promiscuous packet receiving. All packets will be received.
///
#define PXE_OPFLAGS_RECEIVE_FILTER_PROMISCUOUS 0x0008
//
// Enable promiscuous multicast packet receiving. All multicast
// packets will be received.
//
///
/// Enable promiscuous multicast packet receiving. All multicast
/// packets will be received.
///
#define PXE_OPFLAGS_RECEIVE_FILTER_ALL_MULTICAST 0x0010
//

30
MdePkg/Include/Uefi/UefiSpec.h
View File

@ -25,9 +25,9 @@
#include <Protocol/SimpleTextIn.h>
#include <Protocol/SimpleTextOut.h>
//
// Enumeration of memory allocation.
//
///
/// Enumeration of memory allocation.
///
typedef enum {
AllocateAnyPages,
AllocateMaxAddress,
@ -41,9 +41,9 @@ typedef enum {
#define EFI_TIME_ADJUST_DAYLIGHT 0x01
#define EFI_TIME_IN_DAYLIGHT 0x02
//
// Value definition for EFI_TIME.TimeZone
//
///
/// Value definition for EFI_TIME.TimeZone
///
#define EFI_UNSPECIFIED_TIMEZONE 0x07FF
//
@ -62,9 +62,9 @@ typedef enum {
#define EFI_MEMORY_RP 0x0000000000002000ULL
#define EFI_MEMORY_XP 0x0000000000004000ULL
//
// range requires a runtime mapping
//
///
/// range requires a runtime mapping
///
#define EFI_MEMORY_RUNTIME 0x8000000000000000ULL
#define EFI_MEMORY_DESCRIPTOR_VERSION 1
@ -76,15 +76,15 @@ typedef struct {
UINT64 Attribute;
} EFI_MEMORY_DESCRIPTOR;
//
// Build macros to find next EFI_MEMORY_DESCRIPTOR.
//
///
/// Build macros to find next EFI_MEMORY_DESCRIPTOR.
///
#define NextMemoryDescriptor(_Ptr, _Size) ((EFI_MEMORY_DESCRIPTOR *) (((UINT8 *) (_Ptr)) + (_Size)))
#define NEXT_MEMORY_DESCRIPTOR(_Ptr, _Size) NextMemoryDescriptor (_Ptr, _Size)
//
// Declare forward referenced data structures
//
///
/// Declare forward referenced data structures
///
typedef struct _EFI_SYSTEM_TABLE EFI_SYSTEM_TABLE;
/**