Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/Dhcp4.h b/MdePkg/Include/Protocol/Dhcp4.h
index d0e46203261a1a1689726b2505110e897009a08c..95c7701ed08afd3d7dfa4942aa70d7aeb246b7e8 100644 (file)
--- a/MdePkg/Include/Protocol/Dhcp4.h
+++ b/MdePkg/Include/Protocol/Dhcp4.h
@@ -4,7 +4,7 @@
   These protocols are used to collect configuration information for the EFI IPv4 Protocol\r
   drivers and to provide DHCPv4 server and PXE boot server discovery services.\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
+  Copyright (c) 2006 - 2008, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -420,7 +420,42 @@ EFI_STATUS
   )\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
 struct _EFI_DHCP4_PROTOCOL {\r
   EFI_DHCP4_GET_MODE_DATA      GetModeData;\r
   EFI_DHCP4_CONFIGURE          Configure;\r