update codes per MdePkg doxgen review comments.

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

diff --git a/MdePkg/Include/Protocol/Tcp4.h b/MdePkg/Include/Protocol/Tcp4.h
index 01f27fcb8b070eb60f648ee08f5105de5b008e82..d750fe9c788ba2ceb0c0dee81664373510613fe9 100644 (file)
--- a/MdePkg/Include/Protocol/Tcp4.h
+++ b/MdePkg/Include/Protocol/Tcp4.h
@@ -33,7 +33,7 @@
 typedef struct _EFI_TCP4_PROTOCOL EFI_TCP4_PROTOCOL;\r
 \r
 typedef struct {\r
-  EFI_HANDLE        InstanceHandle;\r
+  EFI_HANDLE              InstanceHandle;\r
   EFI_IPv4_ADDRESS        LocalAddress;\r
   UINT16                  LocalPort;\r
   EFI_IPv4_ADDRESS        RemoteAddress;\r
@@ -92,6 +92,9 @@ typedef struct {
   EFI_TCP4_OPTION         *ControlOption;\r
 } EFI_TCP4_CONFIG_DATA;\r
 \r
+///\r
+/// TCP4 connnection state\r
+///\r
 typedef enum {\r
   Tcp4StateClosed         = 0,\r
   Tcp4StateListen         = 1,\r
@@ -185,8 +188,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
   Initialize or brutally reset the operational parameters for this EFI TCPv4 instance.\r
@@ -213,8 +215,7 @@ EFI_STATUS
 (EFIAPI *EFI_TCP4_CONFIGURE)(\r
   IN EFI_TCP4_PROTOCOL                   *This,\r
   IN EFI_TCP4_CONFIG_DATA                *TcpConfigData OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -258,8 +259,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
   Initiate a nonblocking TCP connection request for an active TCP instance.\r
@@ -288,8 +288,7 @@ EFI_STATUS
 (EFIAPI *EFI_TCP4_CONNECT)(\r
   IN EFI_TCP4_PROTOCOL                   *This,\r
   IN EFI_TCP4_CONNECTION_TOKEN           *ConnectionToken\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -318,8 +317,7 @@ EFI_STATUS
 (EFIAPI *EFI_TCP4_ACCEPT)(\r
   IN EFI_TCP4_PROTOCOL                   *This,\r
   IN EFI_TCP4_LISTEN_TOKEN               *ListenToken\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Queues outgoing data into the transmit queue.\r
@@ -357,8 +355,7 @@ EFI_STATUS
 (EFIAPI *EFI_TCP4_TRANSMIT)(\r
   IN EFI_TCP4_PROTOCOL                   *This,\r
   IN EFI_TCP4_IO_TOKEN                   *Token\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -401,8 +398,7 @@ EFI_STATUS
 (EFIAPI *EFI_TCP4_RECEIVE)(\r
   IN EFI_TCP4_PROTOCOL                   *This,\r
   IN EFI_TCP4_IO_TOKEN                   *Token\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Disconnecting a TCP connection gracefully or reset a TCP connection. This function is a\r
@@ -432,8 +428,7 @@ EFI_STATUS
 (EFIAPI *EFI_TCP4_CLOSE)(\r
   IN EFI_TCP4_PROTOCOL                   *This,\r
   IN EFI_TCP4_CLOSE_TOKEN                *CloseToken\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Abort an asynchronous connection, listen, transmission or receive request.\r
@@ -461,8 +456,7 @@ EFI_STATUS
 (EFIAPI *EFI_TCP4_CANCEL)(\r
   IN EFI_TCP4_PROTOCOL                   *This,\r
   IN EFI_TCP4_COMPLETION_TOKEN           *Token OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
 \r
 /**\r
@@ -482,51 +476,15 @@ typedef
 EFI_STATUS\r
 (EFIAPI *EFI_TCP4_POLL)(\r
   IN EFI_TCP4_PROTOCOL                   *This\r
-  )\r
-;\r
-\r
-/**  \r
-  @par Protocol Description:\r
-  The EFI_TCP4_PROTOCOL defines the EFI TCPv4 Protocol child to be used by \r
-  any network drivers or applications to send or receive data stream. \r
-  It can either listen on a specified port as a service or actively connected \r
-  to remote peer as a client. Each instance has its own independent settings, \r
-  such as the routing table.\r
-\r
-  @param GetModeData\r
-  Get the current operational status. \r
-\r
-  @param Configure\r
-  Initialize, change, or brutally reset operational settings of the EFI TCPv4 Protocol. \r
-\r
-  @param Routes\r
-  Add or delete routing entries for this TCP4 instance. \r
-\r
-  @param Connect\r
-  Initiate the TCP three-way handshake to connect to the remote peer \r
-  configured in this TCP instance. The function is a nonblocking operation. \r
-\r
-  @param Accept\r
-  Listen for incoming TCP connection request. This function is a nonblocking operation. \r
-\r
-  @param Transmit\r
-  Queue outgoing data to the transmit queue. This function is a nonblocking operation. \r
-\r
-  @param Receive\r
-  Queue a receiving request token to the receive queue. This function is \r
-  a nonblocking operation. \r
-\r
-  @param Close\r
-  Gracefully disconnecting a TCP connection follow RFC 793 or reset a TCP \r
-  connection. This function is a nonblocking operation. \r
-\r
-  @param Cancel\r
-  Abort a pending connect, listen, transmit or receive request. \r
-\r
-  @param Poll\r
-  Poll to receive incoming data and transmit outgoing TCP segments. \r
-\r
-**/\r
+  );\r
+\r
+///\r
+/// The EFI_TCP4_PROTOCOL defines the EFI TCPv4 Protocol child to be used by \r
+/// any network drivers or applications to send or receive data stream. \r
+/// It can either listen on a specified port as a service or actively connected \r
+/// to remote peer as a client. Each instance has its own independent settings, \r
+/// such as the routing table.\r
+///\r
 struct _EFI_TCP4_PROTOCOL {\r
   EFI_TCP4_GET_MODE_DATA                 GetModeData;\r
   EFI_TCP4_CONFIGURE                     Configure;\r