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

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

diff --git a/MdePkg/Include/Protocol/Udp4.h b/MdePkg/Include/Protocol/Udp4.h
index e5e05fe609527091d2d7a3d05466acc9c77d2c65..f1738163275b0a136651fdd9249b1b9f3110085c 100644 (file)
--- a/MdePkg/Include/Protocol/Udp4.h
+++ b/MdePkg/Include/Protocol/Udp4.h
@@ -4,17 +4,17 @@
   The EFI UDPv4 Protocol provides simple packet-oriented services \r
   to transmit and receive UDP packets.  \r
 \r
   The EFI UDPv4 Protocol provides simple packet-oriented services \r
   to transmit and receive UDP packets.  \r
 \r

-  Copyright (c) 2006 - 2009, 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
 \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
 \r
 **/\r
 \r


@@ -124,11 +124,11 @@ typedef struct {
   optionally to retrieve the operational mode data of underlying networks or\r
   drivers.\r
 \r
   optionally to retrieve the operational mode data of underlying networks or\r
   drivers.\r
 \r

-  @param  This           Pointer to the EFI_UDP4_PROTOCOL instance.\r
-  @param  Udp4ConfigData Pointer to the buffer to receive the current configuration data.\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  SnpModeData    Pointer to the simple network mode data structure.\r
+  @param  This           The pointer to the EFI_UDP4_PROTOCOL instance.\r
+  @param  Udp4ConfigData The pointer to the buffer to receive the current configuration data.\r
+  @param  Ip4ModeData    The pointer to the EFI IPv4 Protocol mode data structure.\r
+  @param  MnpConfigData  The pointer to the managed network configuration data structure.\r
+  @param  SnpModeData    The pointer to the simple network mode data structure.\r

 \r
   @retval EFI_SUCCESS           The mode data was read.\r
   @retval EFI_NOT_STARTED       When Udp4ConfigData is queried, no configuration data is\r
 \r
   @retval EFI_SUCCESS           The mode data was read.\r
   @retval EFI_NOT_STARTED       When Udp4ConfigData is queried, no configuration data is\r


@@ -162,8 +162,8 @@ EFI_STATUS
   With different parameters in UdpConfigData, Configure() can be used to bind\r
   this instance to specified port.\r
 \r
   With different parameters in UdpConfigData, Configure() can be used to bind\r
   this instance to specified port.\r
 \r

-  @param  This           Pointer to the EFI_UDP4_PROTOCOL instance.\r
-  @param  Udp4ConfigData Pointer to the buffer to receive the current configuration data.\r
+  @param  This           The pointer to the EFI_UDP4_PROTOCOL instance.\r
+  @param  Udp4ConfigData The pointer to the buffer to receive the current configuration data.\r

 \r
   @retval EFI_SUCCESS           The configuration settings were set, changed, or reset successfully.\r
   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP,\r
 \r
   @retval EFI_SUCCESS           The configuration settings were set, changed, or reset successfully.\r
   @retval EFI_NO_MAPPING        When using a default address, configuration (DHCP, BOOTP,\r


@@ -194,10 +194,10 @@ EFI_STATUS
   filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all\r
   currently joined groups are left.\r
 \r
   filtering. If the JoinFlag is FALSE and the MulticastAddress is NULL, then all\r
   currently joined groups are left.\r
 \r

-  @param  This             Pointer to the EFI_UDP4_PROTOCOL instance.\r
+  @param  This             The pointer to the EFI_UDP4_PROTOCOL instance.\r

   @param  JoinFlag         Set to TRUE to join a multicast group. Set to FALSE to leave one\r
                            or all multicast groups.\r
   @param  JoinFlag         Set to TRUE to join a multicast group. Set to FALSE to leave one\r
                            or all multicast groups.\r

-  @param  MulticastAddress Pointer to multicast group address to join or leave.\r
+  @param  MulticastAddress The pointer to multicast group address to join or leave.\r

 \r
   @retval EFI_SUCCESS           The operation completed successfully.\r
   @retval EFI_NOT_STARTED       The EFI UDPv4 Protocol instance has not been started.\r
 \r
   @retval EFI_SUCCESS           The operation completed successfully.\r
   @retval EFI_NOT_STARTED       The EFI UDPv4 Protocol instance has not been started.\r


@@ -245,7 +245,7 @@ EFI_STATUS
   copies will be updated automatically whenever the IP driver reconfigures its\r
   instances; as a result, the previous modification to these copies will be lost.\r
 \r
   copies will be updated automatically whenever the IP driver reconfigures its\r
   instances; as a result, the previous modification to these copies will be lost.\r
 \r

-  @param  This           Pointer to the EFI_UDP4_PROTOCOL instance.\r
+  @param  This           The pointer to the EFI_UDP4_PROTOCOL instance.\r

   @param  DeleteRoute    Set to TRUE to delete this route from the routing table.\r
                          Set to FALSE to add this route to the routing table.\r
   @param  SubnetAddress  The destination network address that needs to be routed.\r
   @param  DeleteRoute    Set to TRUE to delete this route from the routing table.\r
                          Set to FALSE to add this route to the routing table.\r
   @param  SubnetAddress  The destination network address that needs to be routed.\r


@@ -284,7 +284,7 @@ EFI_STATUS
   Drivers and applications that are experiencing packet loss should try calling\r
   the Poll() function more often.\r
 \r
   Drivers and applications that are experiencing packet loss should try calling\r
   the Poll() function more often.\r
 \r

-  @param  This Pointer to the EFI_UDP4_PROTOCOL instance.\r
+  @param  This The pointer to the EFI_UDP4_PROTOCOL instance.\r

 \r
   @retval EFI_SUCCESS           Incoming or outgoing data was processed.\r
   @retval EFI_INVALID_PARAMETER This is NULL.\r
 \r
   @retval EFI_SUCCESS           Incoming or outgoing data was processed.\r
   @retval EFI_INVALID_PARAMETER This is NULL.\r


@@ -310,8 +310,8 @@ EFI_STATUS
   will enable the user to receive the notification and receiving status. That\r
   notification function is guaranteed to not be re-entered.\r
 \r
   will enable the user to receive the notification and receiving status. That\r
   notification function is guaranteed to not be re-entered.\r
 \r

-  @param  This  Pointer to the EFI_UDP4_PROTOCOL instance.\r
-  @param  Token Pointer to a token that is associated with the receive data\r
+  @param  This  The pointer to the EFI_UDP4_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
                 descriptor.\r
 \r
   @retval EFI_SUCCESS           The receive completion token was cached.\r


@@ -344,8 +344,8 @@ EFI_STATUS
   and context for the event will enable the user to receive the notification and\r
   transmitting status.\r
 \r
   and context for the event will enable the user to receive the notification and\r
   transmitting status.\r
 \r

-  @param  This  Pointer to the EFI_UDP4_PROTOCOL instance.\r
-  @param  Token Pointer to the completion token that will be placed into the\r
+  @param  This  The pointer to the EFI_UDP4_PROTOCOL instance.\r
+  @param  Token The pointer to the completion token that will be placed into the\r

                 transmit queue.\r
 \r
   @retval EFI_SUCCESS           The data has been queued for transmission.\r
                 transmit queue.\r
 \r
   @retval EFI_SUCCESS           The data has been queued for transmission.\r


@@ -381,8 +381,8 @@ EFI_STATUS
   the asynchronous operation has completed, this function will not signal the\r
   token and EFI_NOT_FOUND is returned.\r
 \r
   the asynchronous operation has completed, this function will not signal the\r
   token and EFI_NOT_FOUND is returned.\r
 \r

-  @param  This  Pointer to the EFI_UDP4_PROTOCOL instance.\r
-  @param  Token Pointer to a token that has been issued by\r
+  @param  This  The pointer to the EFI_UDP4_PROTOCOL instance.\r
+  @param  Token The pointer to a token that has been issued by\r

                 EFI_UDP4_PROTOCOL.Transmit() or\r
                 EFI_UDP4_PROTOCOL.Receive().If NULL, all pending\r
                 tokens are aborted.\r
                 EFI_UDP4_PROTOCOL.Transmit() or\r
                 EFI_UDP4_PROTOCOL.Receive().If NULL, all pending\r
                 tokens are aborted.\r