code scrub fix

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4Dxe / Ip4Common.h

diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Common.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Common.h
index 553714e89b0851777029cdf89c65b2d8ff153af3..af01a03b007f4d2804832708ebf110978f38e81e 100644 (file)
--- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Common.h
+++ b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Common.h
@@ -1,6 +1,7 @@
 /** @file\r
-\r
-Copyright (c) 2005 - 2006, Intel Corporation\r
+  Common definition for IP4.\r
+  \r
+Copyright (c) 2005 - 2006, Intel Corporation.<BR>\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
@@ -9,16 +10,6 @@ http://opensource.org/licenses/bsd-license.php
 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
-\r
-Module Name:\r
-\r
-  Ip4Common.h\r
-\r
-Abstract:\r
-\r
-  Common definition for IP4.\r
-\r
-\r
 **/\r
 \r
 #ifndef __EFI_IP4_COMMON_H__\r
@@ -90,8 +81,8 @@ typedef enum {
   Return the cast type (Unicast/Boradcast) specific to an\r
   interface. All the addresses are host byte ordered.\r
 \r
-  @param  IpAddr                The IP address to classify in host byte order\r
-  @param  IpIf                  The interface that IpAddr received from\r
+  @param[in]  IpAddr                The IP address to classify in host byte order\r
+  @param[in]  IpIf                  The interface that IpAddr received from\r
 \r
   @return The cast type of this IP address specific to the interface.\r
   @retval IP4_LOCAL_HOST        The IpAddr equals to the interface's address\r
@@ -112,11 +103,11 @@ Ip4GetNetCast (
   This isn't the same as link layer cast type. For example, DHCP\r
   server may send local broadcast to the local unicast MAC.\r
 \r
-  @param  IpSb                  The IP4 service binding instance that received the\r
-                                packet\r
-  @param  Dst                   The destination address in the packet (host byte\r
-                                order)\r
-  @param  Src                   The source address in the packet (host byte order)\r
+  @param[in]  IpSb                  The IP4 service binding instance that received the\r
+                                    packet\r
+  @param[in]  Dst                   The destination address in the packet (host byte\r
+                                    order)\r
+  @param[in]  Src                   The source address in the packet (host byte order)\r
 \r
   @return The cast type for the Dst, it will return on the first non-promiscuous\r
           cast type to a configured interface. If the packet doesn't match any of\r
@@ -133,8 +124,8 @@ Ip4GetHostCast (
 /**\r
   Find an interface whose configured IP address is Ip.\r
 \r
-  @param  IpSb                  The IP4 service binding instance\r
-  @param  Ip                    The Ip address (host byte order) to find\r
+  @param[in]  IpSb                  The IP4 service binding instance\r
+  @param[in]  Ip                    The Ip address (host byte order) to find\r
 \r
   @return The IP4_INTERFACE point if found, otherwise NULL\r
 \r
@@ -148,8 +139,8 @@ Ip4FindInterface (
 /**\r
   Find an interface that Ip is on that connected network.\r
 \r
-  @param  IpSb                  The IP4 service binding instance\r
-  @param  Ip                    The Ip address (host byte order) to find\r
+  @param[in]  IpSb                  The IP4 service binding instance\r
+  @param[in]  Ip                    The Ip address (host byte order) to find\r
 \r
   @return The IP4_INTERFACE point if found, otherwise NULL\r
 \r
@@ -163,9 +154,9 @@ Ip4FindNet (
 /**\r
   Find an interface of the service with the same Ip/Netmask pair.\r
 \r
-  @param  IpSb                  Ip4 service binding instance\r
-  @param  Ip                    The Ip adress to find (host byte order)\r
-  @param  Netmask               The network to find (host byte order)\r
+  @param[in]  IpSb                  Ip4 service binding instance\r
+  @param[in]  Ip                    The Ip adress to find (host byte order)\r
+  @param[in]  Netmask               The network to find (host byte order)\r
 \r
   @return The IP4_INTERFACE point if found, otherwise NULL\r
 \r
@@ -182,9 +173,9 @@ Ip4FindStationAddress (
   Mnp's McastIpToMac to find the MAC address in stead of\r
   hard code the NIC to be Ethernet.\r
 \r
-  @param  Mnp                   The Mnp instance to get the MAC address.\r
-  @param  Multicast             The multicast IP address to translate.\r
-  @param  Mac                   The buffer to hold the translated address.\r
+  @param[in]  Mnp                   The Mnp instance to get the MAC address.\r
+  @param[in]  Multicast             The multicast IP address to translate.\r
+  @param[out] Mac                   The buffer to hold the translated address.\r
 \r
   @retval EFI_SUCCESS if the multicast IP is successfully translated to a\r
                       multicast MAC address.\r
@@ -203,7 +194,7 @@ Ip4GetMulticastMac (
   In spite of its name, it can also be used to convert from\r
   host to network byte order.\r
 \r
-  @param  Head                  The IP head to convert\r
+  @param[in]  Head                  The IP head to convert\r
 \r
   @return Point to the converted IP head\r
 \r
@@ -219,7 +210,7 @@ Ip4NtohHead (
   Save the list of all of the IPv4 addresses and subnet masks that are currently\r
   being used to volatile variable storage.\r
 \r
-  @param  IpSb                  Ip4 service binding instance\r
+  @param[in]  IpSb                  Ip4 service binding instance\r
 \r
   @retval EFI_SUCCESS           Successfully set variable.\r
   @retval EFI_OUT_OF_RESOURCES  There are not enough resources to set the variable.\r
@@ -234,9 +225,7 @@ Ip4SetVariableData (
 /**\r
   Clear the variable and free the resource.\r
 \r
-  @param  IpSb                  Ip4 service binding instance\r
-\r
-  @return None.\r
+  @param[in]  IpSb                  Ip4 service binding instance\r
 \r
 **/\r
 VOID\r