Scrubbed part of the code.

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Dhcp4Dxe / Dhcp4Option.h

diff --git a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Option.h b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Option.h
index d3c596c9793944e861ec1bd2a5a127d71642a117..fe62e55085f270fc219233b2fe08a67715df89e4 100644 (file)
--- a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Option.h
+++ b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Option.h
@@ -24,9 +24,9 @@ Abstract:
 #ifndef __EFI_DHCP4_OPTION_H__\r
 #define __EFI_DHCP4_OPTION_H__\r
 \r
-//\r
-// DHCP option tags (types)\r
-//\r
+///\r
+/// DHCP option tags (types)\r
+///\r
 typedef enum {\r
   //\r
   // RFC1497 vendor extensions\r
@@ -158,19 +158,19 @@ typedef enum {
   DHCP_OVERLOAD_BOTH       = 3\r
 } DHCP_OVERLOAD_TYPE;\r
 \r
-//\r
-// The DHCP option structure. This structure extends the EFI_DHCP_OPTION\r
-// structure to support options longer than 255 bytes, such as classless route.\r
-//\r
+///\r
+/// The DHCP option structure. This structure extends the EFI_DHCP_OPTION\r
+/// structure to support options longer than 255 bytes, such as classless route.\r
+///\r
 typedef struct {\r
   UINT8                     Tag;\r
   UINT16                    Len;\r
   UINT8                     *Data;\r
 } DHCP_OPTION;\r
 \r
-//\r
-// Structures used to parse the DHCP options with RFC3396 support.\r
-//\r
+///\r
+/// Structures used to parse the DHCP options with RFC3396 support.\r
+///\r
 typedef struct {\r
   UINT8                     Index;\r
   UINT16                    Offset;\r
@@ -182,11 +182,11 @@ typedef struct {
   UINT8                     *Buf;\r
 } DHCP_OPTION_CONTEXT;\r
 \r
-//\r
-// The options that matters to DHCP driver itself. The user of\r
-// DHCP clients may be interested in other options, such as\r
-// classless route, who can parse the DHCP offer to get them.\r
-//\r
+///\r
+/// The options that matters to DHCP driver itself. The user of\r
+/// DHCP clients may be interested in other options, such as\r
+/// classless route, who can parse the DHCP offer to get them.\r
+///\r
 typedef struct {\r
   IP4_ADDR                  NetMask;  // DHCP_TAG_NETMASK\r
   IP4_ADDR                  Router;   // DHCP_TAG_ROUTER, only the first router is used\r
@@ -202,14 +202,14 @@ typedef struct {
   UINT32                    T2;       // DHCP_TAG_T2\r
 } DHCP_PARAMETER;\r
 \r
-//\r
-// Structure used to describe and validate the format of DHCP options.\r
-// Type is the options' data type, such as DHCP_OPTION_INT8. MinOccur\r
-// is the minium occurance of this data type. MaxOccur is defined\r
-// similarly. If MaxOccur is -1, it means that there is no limit on the\r
-// maximum occurance. Alert tells whether DHCP client should further\r
-// inspect the option to parse DHCP_PARAMETER.\r
-//\r
+///\r
+/// Structure used to describe and validate the format of DHCP options.\r
+/// Type is the options' data type, such as DHCP_OPTION_INT8. MinOccur\r
+/// is the minium occurance of this data type. MaxOccur is defined\r
+/// similarly. If MaxOccur is -1, it means that there is no limit on the\r
+/// maximum occurance. Alert tells whether DHCP client should further\r
+/// inspect the option to parse DHCP_PARAMETER.\r
+///\r
 typedef struct {\r
   UINT8                     Tag;\r
   INTN                      Type;\r