Grammatical and disclaimer changes (does not follow internal C coding stds.)

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

diff --git a/MdePkg/Include/Protocol/Tcp4.h b/MdePkg/Include/Protocol/Tcp4.h
index 82c7344c3e7a149e3a32c87582aac8b2f0cab48b..2a637552d66b6d72d53a97369c699c292d3b82de 100644 (file)
--- a/MdePkg/Include/Protocol/Tcp4.h
+++ b/MdePkg/Include/Protocol/Tcp4.h
@@ -4,17 +4,17 @@
   and destroy child of the driver to communicate with other host using TCP protocol.\r
   The EFI TCPv4 Protocol provides services to send and receive data stream.\r
 \r
-  Copyright (c) 2006 - 2010, 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
-  http://opensource.org/licenses/bsd-license.php\r
-\r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2006 - 2010, Intel Corporation.  All rights reserved<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.                                          \r
+    \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
   @par Revision Reference:\r
-  This Protocol is introduced in UEFI Specification 2.0\r
+  This Protocol is introduced in UEFI Specification 2.0.\r
 \r
 **/\r
 \r
@@ -225,14 +225,14 @@ typedef struct {
 /**\r
   Get the current operational status.\r
 \r
-  @param  This           Pointer to the EFI_TCP4_PROTOCOL instance.\r
-  @param  Tcp4State      Pointer to the buffer to receive the current TCP state.\r
-  @param  Tcp4ConfigData Pointer to the buffer to receive the current TCP configuration.\r
-  @param  Ip4ModeData    Pointer to the buffer to receive the current IPv4 configuration\r
+  @param  This           The pointer to the EFI_TCP4_PROTOCOL instance.\r
+  @param  Tcp4State      The pointer to the buffer to receive the current TCP state.\r
+  @param  Tcp4ConfigData The pointer to the buffer to receive the current TCP configuration.\r
+  @param  Ip4ModeData    The pointer to the buffer to receive the current IPv4 configuration\r
                          data used by the TCPv4 instance.\r
-  @param  MnpConfigData  Pointer to the buffer to receive the current MNP configuration\r
+  @param  MnpConfigData  The pointer to the buffer to receive the current MNP configuration\r
                          data used indirectly by the TCPv4 instance.\r
-  @param  SnpModeData    Pointer to the buffer to receive the current SNP configuration\r
+  @param  SnpModeData    The pointer to the buffer to receive the current SNP configuration\r
                          data used indirectly by the TCPv4 instance.\r
 \r
   @retval EFI_SUCCESS           The mode data was read.\r
@@ -255,8 +255,8 @@ EFI_STATUS
 /**\r
   Initialize or brutally reset the operational parameters for this EFI TCPv4 instance.\r
 \r
-  @param  This           Pointer to the EFI_TCP4_PROTOCOL instance.\r
-  @param  Tcp4ConfigData Pointer to the configure data to configure the instance.\r
+  @param  This           The pointer to the EFI_TCP4_PROTOCOL instance.\r
+  @param  Tcp4ConfigData The pointer to the configure data to configure the instance.\r
 \r
   @retval EFI_SUCCESS           The operational settings are set, changed, or reset\r
                                 successfully.\r
@@ -283,7 +283,7 @@ EFI_STATUS
 /**\r
   Add or delete a route entry to the route table\r
 \r
-  @param  This           Pointer to the EFI_TCP4_PROTOCOL instance.\r
+  @param  This           The pointer to the EFI_TCP4_PROTOCOL instance.\r
   @param  DeleteRoute    Set it to TRUE to delete this route from the routing table. Set it to\r
                          FALSE to add this route to the routing table.\r
                          DestinationAddress and SubnetMask are used as the\r
@@ -326,8 +326,8 @@ EFI_STATUS
 /**\r
   Initiate a nonblocking TCP connection request for an active TCP instance.\r
 \r
-  @param  This                  Pointer to the EFI_TCP4_PROTOCOL instance.\r
-  @param  ConnectionToken       Pointer to the connection token to return when the TCP three\r
+  @param  This                  The pointer to the EFI_TCP4_PROTOCOL instance.\r
+  @param  ConnectionToken       The pointer to the connection token to return when the TCP three\r
                                 way handshake finishes.\r
 \r
   @retval EFI_SUCCESS           The connection request is successfully initiated and the state\r
@@ -355,8 +355,8 @@ EFI_STATUS
 /**\r
   Listen on the passive instance to accept an incoming connection request. This is a nonblocking operation.\r
 \r
-  @param  This        Pointer to the EFI_TCP4_PROTOCOL instance.\r
-  @param  ListenToken Pointer to the listen token to return when operation finishes.\r
+  @param  This        The pointer to the EFI_TCP4_PROTOCOL instance.\r
+  @param  ListenToken The pointer to the listen token to return when operation finishes.\r
 \r
   @retval EFI_SUCCESS           The listen token has been queued successfully.\r
   @retval EFI_NOT_STARTED       This EFI TCPv4 Protocol instance has not been configured.\r
@@ -383,8 +383,8 @@ EFI_STATUS
 /**\r
   Queues outgoing data into the transmit queue.\r
 \r
-  @param  This  Pointer to the EFI_TCP4_PROTOCOL instance.\r
-  @param  Token Pointer to the completion token to queue to the transmit queue.\r
+  @param  This  The pointer to the EFI_TCP4_PROTOCOL instance.\r
+  @param  Token The pointer to the completion token to queue to the transmit queue.\r
 \r
   @retval EFI_SUCCESS             The data has been queued for transmission.\r
   @retval EFI_NOT_STARTED         This EFI TCPv4 Protocol instance has not been configured.\r
@@ -422,8 +422,8 @@ EFI_STATUS
 /**\r
   Places an asynchronous receive request into the receiving queue.\r
 \r
-  @param  This  Pointer to the EFI_TCP4_PROTOCOL instance.\r
-  @param  Token Pointer to a token that is associated with the receive data\r
+  @param  This  The pointer to the EFI_TCP4_PROTOCOL instance.\r
+  @param  Token The pointer to a token that is associated with the receive data\r
                 descriptor.\r
 \r
   @retval EFI_SUCCESS           The receive completion token was cached.\r
@@ -465,8 +465,8 @@ EFI_STATUS
   Disconnecting a TCP connection gracefully or reset a TCP connection. This function is a\r
   nonblocking operation.\r
 \r
-  @param  This       Pointer to the EFI_TCP4_PROTOCOL instance.\r
-  @param  CloseToken Pointer to the close token to return when operation finishes.\r
+  @param  This       The pointer to the EFI_TCP4_PROTOCOL instance.\r
+  @param  CloseToken The pointer to the close token to return when operation finishes.\r
 \r
   @retval EFI_SUCCESS           The Close() is called successfully.\r
   @retval EFI_NOT_STARTED       This EFI TCPv4 Protocol instance has not been configured.\r
@@ -494,8 +494,8 @@ EFI_STATUS
 /**\r
   Abort an asynchronous connection, listen, transmission or receive request.\r
 \r
-  @param  This  Pointer to the EFI_TCP4_PROTOCOL instance.\r
-  @param  Token Pointer to a token that has been issued by\r
+  @param  This  The pointer to the EFI_TCP4_PROTOCOL instance.\r
+  @param  Token The pointer to a token that has been issued by\r
                 EFI_TCP4_PROTOCOL.Connect(),\r
                 EFI_TCP4_PROTOCOL.Accept(),\r
                 EFI_TCP4_PROTOCOL.Transmit() or\r
@@ -527,7 +527,7 @@ EFI_STATUS
 /**\r
   Poll to receive incoming data and transmit outgoing segments.\r
 \r
-  @param  This Pointer to the EFI_TCP4_PROTOCOL instance.\r
+  @param  This The pointer to the EFI_TCP4_PROTOCOL instance.\r
 \r
   @retval  EFI_SUCCESS           Incoming or outgoing data was processed.\r
   @retval  EFI_INVALID_PARAMETER This is NULL.\r