Fix doxygen comment for structure and macro

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

diff --git a/MdePkg/Include/Protocol/Ip4.h b/MdePkg/Include/Protocol/Ip4.h
index 99885496458d945a4f3053e2ac9cc57ea4685fd4..df6fd03cd57730f426dd3e6847615a3010125a36 100644 (file)
--- a/MdePkg/Include/Protocol/Ip4.h
+++ b/MdePkg/Include/Protocol/Ip4.h
@@ -1,5 +1,17 @@
 /** @file\r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  \r
+  This file defines the EFI IPv4 (Internet Protocol version 4)\r
+  Protocol interface. It is split into the following three main\r
+  sections:\r
+  - EFI IPv4 Service Binding Protocol\r
+  - EFI IPv4 Variable\r
+  - EFI IPv4 Protocol The EFI IPv4 Protocol provides basic\r
+    network IPv4 packet I/O services, which includes support for\r
+    a subset of the Internet Control Message Protocol (ICMP) and\r
+    may include support for the Internet Group Management\r
+    Protocol (IGMP).\r
+  \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
@@ -151,7 +163,7 @@ typedef struct {
   @param  This          Pointer to the EFI_IP4_PROTOCOL instance.\r
   @param  Ip4ModeData   Pointer to the EFI IPv4 Protocol mode data structure.\r
   @param  MnpConfigData Pointer to the managed network configuration data structure.\r
-  @param  SnpData       Pointer to the simple network mode data structure.\r
+  @param  SnpModeData   Pointer to the simple network mode data structure.\r
 \r
   @retval EFI_SUCCESS           The operation completed successfully.\r
   @retval EFI_INVALID_PARAMETER This is NULL.\r
@@ -160,13 +172,12 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_IP4_GET_MODE_DATA) (\r
+(EFIAPI *EFI_IP4_GET_MODE_DATA)(\r
   IN CONST  EFI_IP4_PROTOCOL                *This,\r
   OUT       EFI_IP4_MODE_DATA               *Ip4ModeData     OPTIONAL,\r
   OUT       EFI_MANAGED_NETWORK_CONFIG_DATA *MnpConfigData   OPTIONAL,\r
   OUT       EFI_SIMPLE_NETWORK_MODE         *SnpModeData     OPTIONAL\r
-  )\r
-;  \r
+  );  \r
 \r
 /**\r
   Assigns an IPv4 address and subnet mask to this EFI IPv4 Protocol driver instance.\r
@@ -188,16 +199,15 @@ EFI_STATUS
                                 IPv4 address or subnet mask can be changed. The interface must\r
                                 also be stopped when switching to/from raw packet mode.\r
   @retval EFI_DEVICE_ERROR      An unexpected system or network error occurred. The EFI IPv4\r
-                                 Protocol driver instance is not opened.\r
+                                Protocol driver instance is not opened.\r
 \r
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_IP4_CONFIGURE) (\r
+(EFIAPI *EFI_IP4_CONFIGURE)(\r
   IN EFI_IP4_PROTOCOL    *This,\r
   IN EFI_IP4_CONFIG_DATA *IpConfigData     OPTIONAL\r
-  )\r
-;  \r
+  );  \r
 \r
 /**\r
   Joins and leaves multicast groups.\r
@@ -225,12 +235,11 @@ EFI_STATUS
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_IP4_GROUPS) (\r
+(EFIAPI *EFI_IP4_GROUPS)(\r
   IN EFI_IP4_PROTOCOL    *This,\r
   IN BOOLEAN             JoinFlag,\r
   IN EFI_IPv4_ADDRESS    *GroupAddress  OPTIONAL\r
-  )\r
-;    \r
+  );    \r
 \r
 /**\r
   Adds and deletes routing table entries.\r
@@ -263,14 +272,13 @@ EFI_STATUS
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_IP4_ROUTES) (\r
+(EFIAPI *EFI_IP4_ROUTES)(\r
   IN EFI_IP4_PROTOCOL    *This,\r
   IN BOOLEAN             DeleteRoute,\r
   IN EFI_IPv4_ADDRESS    *SubnetAddress,\r
   IN EFI_IPv4_ADDRESS    *SubnetMask,\r
   IN EFI_IPv4_ADDRESS    *GatewayAddress  \r
-  )\r
-;  \r
+  );  \r
 \r
 /**\r
   Places outgoing data packets into the transmit queue.\r
@@ -299,11 +307,10 @@ EFI_STATUS
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_IP4_TRANSMIT) (\r
+(EFIAPI *EFI_IP4_TRANSMIT)(\r
   IN EFI_IP4_PROTOCOL          *This,\r
   IN EFI_IP4_COMPLETION_TOKEN  *Token\r
-  )\r
-;    \r
+  );    \r
 \r
 /**\r
   Places a receiving request into the receiving queue.\r
@@ -331,11 +338,10 @@ EFI_STATUS
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_IP4_RECEIVE) (\r
+(EFIAPI *EFI_IP4_RECEIVE)(\r
   IN EFI_IP4_PROTOCOL          *This,\r
   IN EFI_IP4_COMPLETION_TOKEN  *Token\r
-  )\r
-;      \r
+  );      \r
 \r
 /**\r
   Abort an asynchronous transmit or receive request.\r
@@ -361,11 +367,10 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_IP4_CANCEL) (\r
+(EFIAPI *EFI_IP4_CANCEL)(\r
   IN EFI_IP4_PROTOCOL          *This,\r
   IN EFI_IP4_COMPLETION_TOKEN  *Token OPTIONAL\r
-  )\r
-;      \r
+  );      \r
   \r
 /**\r
   Polls for incoming data packets and processes outgoing data packets.\r
@@ -385,11 +390,15 @@ EFI_STATUS
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_IP4_POLL) (\r
+(EFIAPI *EFI_IP4_POLL)(\r
   IN EFI_IP4_PROTOCOL          *This\r
-  )\r
-;  \r
+  );  \r
 \r
+/**  \r
+  @par Protocol Description:\r
+  The EFI IPv4 Protocol implements a simple packet-oriented interface that can be \r
+  used by drivers, daemons, and applications to transmit and receive network packets.\r
+**/\r
 struct _EFI_IP4_PROTOCOL {\r
   EFI_IP4_GET_MODE_DATA        GetModeData;\r
   EFI_IP4_CONFIGURE            Configure;\r