clean up the un-suitable ';' location when declaring the functions.

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

diff --git a/MdePkg/Include/Protocol/Udp4.h b/MdePkg/Include/Protocol/Udp4.h
index 4e158a2ecaba5537c530a470194e32843338b343..8e2511faabe3fde258a9a306ae55c19cf39f9a7d 100644 (file)
--- a/MdePkg/Include/Protocol/Udp4.h
+++ b/MdePkg/Include/Protocol/Udp4.h
@@ -1,7 +1,10 @@
 /** @file\r
-  UDP4 Service Binding Protocol\r
+  UDP4 Service Binding Protocol as defined in UEFI specification.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  The EFI UDPv4 Protocol provides simple packet-oriented services \r
+  to transmit and receive UDP packets.  \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
@@ -142,8 +145,7 @@ EFI_STATUS
   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
 /**\r
@@ -173,8 +175,7 @@ EFI_STATUS
 (EFIAPI *EFI_UDP4_CONFIGURE)(\r
   IN EFI_UDP4_PROTOCOL      *This,\r
   IN EFI_UDP4_CONFIG_DATA   *UdpConfigData OPTIONAL\r
-  )\r
-;  \r
+  );  \r
 \r
 /**\r
   Joins and leaves multicast groups.\r
@@ -207,8 +208,7 @@ EFI_STATUS
   IN EFI_UDP4_PROTOCOL      *This,\r
   IN BOOLEAN                JoinFlag,\r
   IN EFI_IPv4_ADDRESS       *MulticastAddress    OPTIONAL\r
-  )\r
-;   \r
+  );   \r
 \r
 /**\r
   Adds and deletes routing table entries.\r
@@ -238,8 +238,7 @@ EFI_STATUS
   IN EFI_IPv4_ADDRESS       *SubnetAddress,\r
   IN EFI_IPv4_ADDRESS       *SubnetMask,\r
   IN EFI_IPv4_ADDRESS       *GatewayAddress\r
-  )\r
-;     \r
+  );     \r
 \r
 /**\r
   Polls for incoming data packets and processes outgoing data packets.\r
@@ -256,8 +255,7 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_UDP4_POLL)(\r
   IN EFI_UDP4_PROTOCOL      *This\r
-  )\r
-;   \r
+  );   \r
 \r
 /**\r
   Places an asynchronous receive request into the receiving queue.\r
@@ -284,8 +282,7 @@ EFI_STATUS
 (EFIAPI *EFI_UDP4_RECEIVE)(\r
   IN EFI_UDP4_PROTOCOL          *This,\r
   IN EFI_UDP4_COMPLETION_TOKEN  *Token\r
-  )\r
-;   \r
+  );   \r
 \r
 /**\r
   Queues outgoing data packets into the transmit queue.\r
@@ -315,8 +312,7 @@ EFI_STATUS
 (EFIAPI *EFI_UDP4_TRANSMIT)(\r
   IN EFI_UDP4_PROTOCOL           *This,\r
   IN EFI_UDP4_COMPLETION_TOKEN   *Token\r
-  )\r
-;     \r
+  );     \r
 \r
 /**\r
   Aborts an asynchronous transmit or receive request.\r
@@ -344,9 +340,40 @@ EFI_STATUS
 (EFIAPI *EFI_UDP4_CANCEL)(\r
   IN EFI_UDP4_PROTOCOL          *This,\r
   IN EFI_UDP4_COMPLETION_TOKEN  *Token  OPTIONAL\r
-  )\r
-;       \r
+  );       \r
+\r
+/**  \r
+  @par Protocol Description:\r
+  The EFI_UDP4_PROTOCOL defines an EFI UDPv4 Protocol session that can be used \r
+  by any network drivers, applications, or daemons to transmit or receive UDP packets. \r
+  This protocol instance can either be bound to a specified port as a service or \r
+  connected to some remote peer as an active client. Each instance has its own settings, \r
+  such as the routing table and group table, which are independent from each other.\r
+\r
+  @param GetModeData\r
+  Reads the current operational settings. \r
+\r
+  @param Configure\r
+  Initializes, changes, or resets operational settings for the EFI UDPv4 Protocol. \r
+\r
+  @param Groups\r
+  Joins and leaves multicast groups. \r
 \r
+  @param Routes\r
+  Add and deletes routing table entries. \r
+\r
+  @param Transmit\r
+  Queues outgoing data packets into the transmit queue. This function is a nonblocked operation. \r
+\r
+  @param Receive\r
+  Places a receiving request token into the receiving queue. This function is a nonblocked operation. \r
+\r
+  @param Cancel\r
+  Aborts a pending transmit or receive request. \r
+\r
+  @param Poll\r
+  Polls for incoming data packets and processes outgoing data packets.   \r
+**/\r
 struct _EFI_UDP4_PROTOCOL {\r
   EFI_UDP4_GET_MODE_DATA        GetModeData;\r
   EFI_UDP4_CONFIGURE            Configure;\r