diff options
| author | klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-08-14 04:29:48 +0000 |
|---|---|---|
| committer | klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-08-14 04:29:48 +0000 |
| commit | 99e8ed219f48b82694424e46c9512d4929d9d54e (patch) | |
| tree | c53470e18c4befeac367d28e285176f3f0c1e88b /MdePkg/Include/Protocol/PxeBaseCode.h | |
| parent | 06889842319d8fc9dd46a4b5dd1804df02e9cece (diff) | |
| download | edk2-99e8ed219f48b82694424e46c9512d4929d9d54e.zip edk2-99e8ed219f48b82694424e46c9512d4929d9d54e.tar.gz edk2-99e8ed219f48b82694424e46c9512d4929d9d54e.tar.bz2 | |
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@5649 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Protocol/PxeBaseCode.h')
| -rw-r--r-- | MdePkg/Include/Protocol/PxeBaseCode.h | 60 |
1 files changed, 30 insertions, 30 deletions
diff --git a/MdePkg/Include/Protocol/PxeBaseCode.h b/MdePkg/Include/Protocol/PxeBaseCode.h index c341d46..4958cdf 100644 --- a/MdePkg/Include/Protocol/PxeBaseCode.h +++ b/MdePkg/Include/Protocol/PxeBaseCode.h @@ -15,9 +15,9 @@ #ifndef __PXE_BASE_CODE_PROTOCOL_H__
#define __PXE_BASE_CODE_PROTOCOL_H__
-//
-// PXE Base Code protocol
-//
+///
+/// PXE Base Code protocol
+///
#define EFI_PXE_BASE_CODE_PROTOCOL_GUID \
{ \
0x03c4e603, 0xac28, 0x11d3, {0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \
@@ -25,20 +25,20 @@ typedef struct _EFI_PXE_BASE_CODE_PROTOCOL EFI_PXE_BASE_CODE_PROTOCOL;
-//
-// Protocol defined in EFI1.1.
-//
+///
+/// Protocol defined in EFI1.1.
+///
typedef EFI_PXE_BASE_CODE_PROTOCOL EFI_PXE_BASE_CODE;
-//
-// Default IP TTL and ToS.
-//
+///
+/// Default IP TTL and ToS.
+///
#define DEFAULT_TTL 16
#define DEFAULT_ToS 0
-//
-// ICMP error format
-//
+///
+/// ICMP error format
+///
typedef struct {
UINT8 Type;
UINT8 Code;
@@ -55,17 +55,17 @@ typedef struct { UINT8 Data[494];
} EFI_PXE_BASE_CODE_ICMP_ERROR;
-//
-// TFTP error format
-//
+///
+/// TFTP error format
+///
typedef struct {
UINT8 ErrorCode;
CHAR8 ErrorString[127];
} EFI_PXE_BASE_CODE_TFTP_ERROR;
-//
-// IP Receive Filter definitions
-//
+///
+/// IP Receive Filter definitions
+///
#define EFI_PXE_BASE_CODE_MAX_IPCNT 8
typedef struct {
@@ -80,9 +80,9 @@ typedef struct { #define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS 0x0004
#define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST 0x0008
-//
-// ARP Cache definitions
-//
+///
+/// ARP Cache definitions
+///
typedef struct {
EFI_IP_ADDRESS IpAddr;
EFI_MAC_ADDRESS MacAddr;
@@ -136,9 +136,9 @@ typedef UINT16 EFI_PXE_BASE_CODE_UDP_PORT; #define EFI_PXE_BASE_CODE_BOOT_LAYER_MASK 0x7FFF
#define EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL 0x0000
-//
-// Discover() server list structure.
-//
+///
+/// Discover() server list structure.
+///
typedef struct {
UINT16 Type;
BOOLEAN AcceptAnyResponse;
@@ -146,9 +146,9 @@ typedef struct { EFI_IP_ADDRESS IpAddr;
} EFI_PXE_BASE_CODE_SRVLIST;
-//
-// Discover() information override structure.
-//
+///
+/// Discover() information override structure.
+///
typedef struct {
BOOLEAN UseMCast;
BOOLEAN UseBCast;
@@ -159,9 +159,9 @@ typedef struct { EFI_PXE_BASE_CODE_SRVLIST SrvList[1];
} EFI_PXE_BASE_CODE_DISCOVER_INFO;
-//
-// Mtftp() definitions
-//
+///
+/// Mtftp() definitions
+///
typedef enum {
EFI_PXE_BASE_CODE_TFTP_FIRST,
EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE,
|