Use doxygen comment style for document entity such as struct, enum, variable that...

[mirror_edk2.git] / MdePkg / Include / Protocol / PxeBaseCode.h

diff --git a/MdePkg/Include/Protocol/PxeBaseCode.h b/MdePkg/Include/Protocol/PxeBaseCode.h
index c341d46aeca6e1b04f900b2deefe6359b1afd4a4..4958cdfb1f6c9263d680112ae133bc833f56995f 100644 (file)
--- a/MdePkg/Include/Protocol/PxeBaseCode.h
+++ b/MdePkg/Include/Protocol/PxeBaseCode.h
@@ -15,9 +15,9 @@
 #ifndef __PXE_BASE_CODE_PROTOCOL_H__\r
 #define __PXE_BASE_CODE_PROTOCOL_H__\r
 \r
-//\r
-// PXE Base Code protocol\r
-//\r
+///\r
+/// PXE Base Code protocol\r
+///\r
 #define EFI_PXE_BASE_CODE_PROTOCOL_GUID \\r
   { \\r
     0x03c4e603, 0xac28, 0x11d3, {0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
@@ -25,20 +25,20 @@
 \r
 typedef struct _EFI_PXE_BASE_CODE_PROTOCOL  EFI_PXE_BASE_CODE_PROTOCOL;\r
 \r
-//\r
-// Protocol defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol defined in EFI1.1.\r
+/// \r
 typedef EFI_PXE_BASE_CODE_PROTOCOL  EFI_PXE_BASE_CODE;\r
 \r
-//\r
-// Default IP TTL and ToS.\r
-//\r
+///\r
+/// Default IP TTL and ToS.\r
+///\r
 #define DEFAULT_TTL 16\r
 #define DEFAULT_ToS 0\r
 \r
-//\r
-// ICMP error format\r
-//\r
+///\r
+/// ICMP error format\r
+///\r
 typedef struct {\r
   UINT8   Type;\r
   UINT8   Code;\r
@@ -55,17 +55,17 @@ typedef struct {
   UINT8 Data[494];\r
 } EFI_PXE_BASE_CODE_ICMP_ERROR;\r
 \r
-//\r
-// TFTP error format\r
-//\r
+///\r
+/// TFTP error format\r
+///\r
 typedef struct {\r
   UINT8 ErrorCode;\r
   CHAR8 ErrorString[127];\r
 } EFI_PXE_BASE_CODE_TFTP_ERROR;\r
 \r
-//\r
-// IP Receive Filter definitions\r
-//\r
+///\r
+/// IP Receive Filter definitions\r
+///\r
 #define EFI_PXE_BASE_CODE_MAX_IPCNT 8\r
 \r
 typedef struct {\r
@@ -80,9 +80,9 @@ typedef struct {
 #define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS           0x0004\r
 #define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST 0x0008\r
 \r
-//\r
-// ARP Cache definitions\r
-//\r
+///\r
+/// ARP Cache definitions\r
+///\r
 typedef struct {\r
   EFI_IP_ADDRESS  IpAddr;\r
   EFI_MAC_ADDRESS MacAddr;\r
@@ -136,9 +136,9 @@ typedef UINT16  EFI_PXE_BASE_CODE_UDP_PORT;
 #define EFI_PXE_BASE_CODE_BOOT_LAYER_MASK     0x7FFF\r
 #define EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL  0x0000\r
 \r
-//\r
-// Discover() server list structure.\r
-//\r
+///\r
+/// Discover() server list structure.\r
+///\r
 typedef struct {\r
   UINT16          Type;\r
   BOOLEAN         AcceptAnyResponse;\r
@@ -146,9 +146,9 @@ typedef struct {
   EFI_IP_ADDRESS  IpAddr;\r
 } EFI_PXE_BASE_CODE_SRVLIST;\r
 \r
-//\r
-// Discover() information override structure.\r
-//\r
+///\r
+/// Discover() information override structure.\r
+///\r
 typedef struct {\r
   BOOLEAN                   UseMCast;\r
   BOOLEAN                   UseBCast;\r
@@ -159,9 +159,9 @@ typedef struct {
   EFI_PXE_BASE_CODE_SRVLIST SrvList[1];\r
 } EFI_PXE_BASE_CODE_DISCOVER_INFO;\r
 \r
-//\r
-// Mtftp() definitions\r
-//\r
+///\r
+/// Mtftp() definitions\r
+///\r
 typedef enum {\r
   EFI_PXE_BASE_CODE_TFTP_FIRST,\r
   EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE,\r