Formalize comments for Protocols and PPIs.

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

diff --git a/MdePkg/Include/Protocol/Dhcp4.h b/MdePkg/Include/Protocol/Dhcp4.h
index 95c7701ed08afd3d7dfa4942aa70d7aeb246b7e8..cefa8de73ae4a3bcc1f007291a903e71f9fc07c7 100644 (file)
--- a/MdePkg/Include/Protocol/Dhcp4.h
+++ b/MdePkg/Include/Protocol/Dhcp4.h
@@ -49,11 +49,11 @@ typedef struct {
     UINT32            Xid;\r
     UINT16            Seconds;\r
     UINT16            Reserved;\r
-    EFI_IPv4_ADDRESS  ClientAddr;       //Client IP address from client\r
-    EFI_IPv4_ADDRESS  YourAddr;         //Client IP address from server\r
-    EFI_IPv4_ADDRESS  ServerAddr;       //IP address of next server in bootstrap\r
-    EFI_IPv4_ADDRESS  GatewayAddr;      //Relay agent IP address\r
-    UINT8             ClientHwAddr[16]; //Client hardware address\r
+    EFI_IPv4_ADDRESS  ClientAddr;       ///< Client IP address from client\r
+    EFI_IPv4_ADDRESS  YourAddr;         ///< Client IP address from server\r
+    EFI_IPv4_ADDRESS  ServerAddr;       ///< IP address of next server in bootstrap\r
+    EFI_IPv4_ADDRESS  GatewayAddr;      ///< Relay agent IP address\r
+    UINT8             ClientHwAddr[16]; ///< Client hardware address\r
     CHAR8             ServerName[64];\r
     CHAR8             BootFileName[128];\r
 }EFI_DHCP4_HEADER;\r
@@ -199,8 +199,7 @@ EFI_STATUS
 (EFIAPI *EFI_DHCP4_GET_MODE_DATA)(\r
   IN  EFI_DHCP4_PROTOCOL      *This,\r
   OUT EFI_DHCP4_MODE_DATA     *Dhcp4ModeData\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Initializes, changes, or resets the operational settings for the EFI DHCPv4 Protocol driver.\r
@@ -226,8 +225,7 @@ EFI_STATUS
 (EFIAPI *EFI_DHCP4_CONFIGURE)(\r
   IN EFI_DHCP4_PROTOCOL       *This,\r
   IN EFI_DHCP4_CONFIG_DATA    *Dhcp4CfgData  OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -261,8 +259,7 @@ EFI_STATUS
 (EFIAPI *EFI_DHCP4_START)(\r
   IN EFI_DHCP4_PROTOCOL       *This,\r
   IN EFI_EVENT                CompletionEvent   OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Extends the lease time by sending a request packet.\r
@@ -296,8 +293,7 @@ EFI_STATUS
   IN EFI_DHCP4_PROTOCOL       *This,\r
   IN BOOLEAN                  RebindRequest,\r
   IN EFI_EVENT                CompletionEvent  OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Releases the current address configuration.\r
@@ -314,8 +310,7 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_DHCP4_RELEASE)(\r
   IN EFI_DHCP4_PROTOCOL       *This\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Stops the current address configuration.\r
@@ -330,14 +325,13 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_DHCP4_STOP)(\r
   IN EFI_DHCP4_PROTOCOL       *This\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Builds a DHCP packet, given the options to be appended or deleted or replaced.\r
 \r
   @param  This        Pointer to the EFI_DHCP4_PROTOCOL instance.\r
- @param  SeedPacket  Initial packet to be used as a base for building new packet.\r
+  @param  SeedPacket  Initial packet to be used as a base for building new packet.\r
   @param  DeleteCount Number of opcodes in the DeleteList.\r
   @param  DeleteList  List of opcodes to be deleted from the seed packet.\r
                       Ignored if DeleteCount is zero.\r
@@ -365,8 +359,7 @@ EFI_STATUS
   IN  UINT32                  AppendCount,\r
   IN  EFI_DHCP4_PACKET_OPTION *AppendList[]       OPTIONAL,\r
   OUT EFI_DHCP4_PACKET        **NewPacket\r
-  )\r
-;\r
+  );\r
 /**\r
   Transmits a DHCP formatted packet and optionally waits for responses.\r
 \r
@@ -387,8 +380,7 @@ EFI_STATUS
 (EFIAPI *EFI_DHCP4_TRANSMIT_RECEIVE)(\r
   IN EFI_DHCP4_PROTOCOL                *This,\r
   IN EFI_DHCP4_TRANSMIT_RECEIVE_TOKEN  *Token\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -417,45 +409,12 @@ EFI_STATUS
   IN EFI_DHCP4_PACKET          *Packet,\r
   IN OUT UINT32                *OptionCount,\r
   OUT EFI_DHCP4_PACKET_OPTION  *PacketOptionList[]  OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
-/**\r
-  @par Protocol Description:\r
-  This protocol is used to collect configuration information for the EFI IPv4 Protocol drivers\r
-  and to provide DHCPv4 server and PXE boot server discovery services.\r
-\r
-  @param GetModeData \r
-  Gets the EFI DHCPv4 Protocol driver status and operational data.\r
-\r
-  @param Configure \r
-  Initializes, changes, or resets operational settings for the EFI\r
-  DHCPv4 Protocol driver.\r
-  \r
-  @param Start\r
-  Starts the DHCP configuration process. \r
-  \r
-  @param RenewRebind \r
-  Tries to manually extend the lease time by sending a request packet.\r
-\r
-  @param Release \r
-  Releases the current configuration and returns the EFI DHCPv4\r
-  Protocol driver to the initial state.\r
-  \r
-  @param Stop\r
-  Stops the DHCP configuration process no matter what state the\r
-  driver is in. After being stopped, this driver will not automatically\r
-  communicate with the DHCP server.\r
-  \r
-  @param Build \r
-  Puts together a DHCP or PXE packet. \r
-  \r
-  @param TransmitReceive \r
-  Transmits a DHCP or PXE packet and waits for response packets.\r
-\r
-  @param Parse \r
-  Parses the packed DHCP or PXE option data. \r
-**/\r
+///\r
+/// This protocol is used to collect configuration information for the EFI IPv4 Protocol drivers\r
+/// and to provide DHCPv4 server and PXE boot server discovery services.\r
+///\r
 struct _EFI_DHCP4_PROTOCOL {\r
   EFI_DHCP4_GET_MODE_DATA      GetModeData;\r
   EFI_DHCP4_CONFIGURE          Configure;\r