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 e7fc60ecde91646b589805a87c43e390a927286b..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
@@ -331,7 +331,7 @@ EFI_STATUS
   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
@@ -411,42 +411,10 @@ EFI_STATUS
   OUT EFI_DHCP4_PACKET_OPTION  *PacketOptionList[]  OPTIONAL\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