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 486899fdce4b3be496c6230c414e061b0f4efd4f..cefa8de73ae4a3bcc1f007291a903e71f9fc07c7 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
@@ -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
@@ -126,7 +126,7 @@ typedef enum{
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DHCP4_CALLBACK) (\r
+(EFIAPI *EFI_DHCP4_CALLBACK)(\r
   IN  EFI_DHCP4_PROTOCOL         *This,\r
   IN  VOID                       *Context,\r
   IN  EFI_DHCP4_STATE            CurrentState,\r
@@ -196,11 +196,10 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DHCP4_GET_MODE_DATA) (\r
+(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
@@ -223,11 +222,10 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DHCP4_CONFIGURE) (\r
+(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
@@ -258,11 +256,10 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DHCP4_START) (\r
+(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
@@ -292,12 +289,11 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DHCP4_RENEW_REBIND) (\r
+(EFIAPI *EFI_DHCP4_RENEW_REBIND)(\r
   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
@@ -312,10 +308,9 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DHCP4_RELEASE) (\r
+(EFIAPI *EFI_DHCP4_RELEASE)(\r
   IN EFI_DHCP4_PROTOCOL       *This\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Stops the current address configuration.\r
@@ -328,16 +323,15 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DHCP4_STOP) (\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
@@ -357,7 +351,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DHCP4_BUILD) (\r
+(EFIAPI *EFI_DHCP4_BUILD)(\r
   IN  EFI_DHCP4_PROTOCOL      *This,\r
   IN  EFI_DHCP4_PACKET        *SeedPacket,\r
   IN  UINT32                  DeleteCount,\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
@@ -384,11 +377,10 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DHCP4_TRANSMIT_RECEIVE) (\r
+(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
@@ -412,15 +404,17 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DHCP4_PARSE) (\r
+(EFIAPI *EFI_DHCP4_PARSE)(\r
   IN EFI_DHCP4_PROTOCOL        *This,\r
   IN EFI_DHCP4_PACKET          *Packet,\r
   IN OUT UINT32                *OptionCount,\r
   OUT EFI_DHCP4_PACKET_OPTION  *PacketOptionList[]  OPTIONAL\r
-  )\r
-;\r
-\r
+  );\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