summaryrefslogtreecommitdiff
path: root/MdePkg/Include/Protocol/Dhcp4.h
diff options
context:
space:
mode:
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2008-10-09 18:09:49 +0000
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>2008-10-09 18:09:49 +0000
commit3354353d4d82fb12c073564ab41099ca75d02839 (patch)
tree2a2e1b59a56d16a76e64530d3f424cad8c02e2e1 /MdePkg/Include/Protocol/Dhcp4.h
parent8b6c989b0dce2e63a06139f37be0e062588e8f04 (diff)
downloadedk2-platforms-3354353d4d82fb12c073564ab41099ca75d02839.tar.xz
Fix doxygen comment for structure and macro
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6093 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Protocol/Dhcp4.h')
-rw-r--r--MdePkg/Include/Protocol/Dhcp4.h41
1 files changed, 5 insertions, 36 deletions
diff --git a/MdePkg/Include/Protocol/Dhcp4.h b/MdePkg/Include/Protocol/Dhcp4.h
index e7fc60ecde..2031f2b5da 100644
--- a/MdePkg/Include/Protocol/Dhcp4.h
+++ b/MdePkg/Include/Protocol/Dhcp4.h
@@ -49,11 +49,11 @@ typedef struct {
UINT32 Xid;
UINT16 Seconds;
UINT16 Reserved;
- EFI_IPv4_ADDRESS ClientAddr; //Client IP address from client
- EFI_IPv4_ADDRESS YourAddr; //Client IP address from server
- EFI_IPv4_ADDRESS ServerAddr; //IP address of next server in bootstrap
- EFI_IPv4_ADDRESS GatewayAddr; //Relay agent IP address
- UINT8 ClientHwAddr[16]; //Client hardware address
+ EFI_IPv4_ADDRESS ClientAddr; ///< Client IP address from client
+ EFI_IPv4_ADDRESS YourAddr; ///< Client IP address from server
+ EFI_IPv4_ADDRESS ServerAddr; ///< IP address of next server in bootstrap
+ EFI_IPv4_ADDRESS GatewayAddr; ///< Relay agent IP address
+ UINT8 ClientHwAddr[16]; ///< Client hardware address
CHAR8 ServerName[64];
CHAR8 BootFileName[128];
}EFI_DHCP4_HEADER;
@@ -415,37 +415,6 @@ EFI_STATUS
@par Protocol Description:
This protocol is used to collect configuration information for the EFI IPv4 Protocol drivers
and to provide DHCPv4 server and PXE boot server discovery services.
-
- @param GetModeData
- Gets the EFI DHCPv4 Protocol driver status and operational data.
-
- @param Configure
- Initializes, changes, or resets operational settings for the EFI
- DHCPv4 Protocol driver.
-
- @param Start
- Starts the DHCP configuration process.
-
- @param RenewRebind
- Tries to manually extend the lease time by sending a request packet.
-
- @param Release
- Releases the current configuration and returns the EFI DHCPv4
- Protocol driver to the initial state.
-
- @param Stop
- Stops the DHCP configuration process no matter what state the
- driver is in. After being stopped, this driver will not automatically
- communicate with the DHCP server.
-
- @param Build
- Puts together a DHCP or PXE packet.
-
- @param TransmitReceive
- Transmits a DHCP or PXE packet and waits for response packets.
-
- @param Parse
- Parses the packed DHCP or PXE option data.
**/
struct _EFI_DHCP4_PROTOCOL {
EFI_DHCP4_GET_MODE_DATA GetModeData;