Fix doxygen issue:

[mirror_edk2.git] / MdePkg / Include / Uefi / UefiPxe.h

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