code scrub fix

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4Dxe / Ip4Icmp.c

diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Icmp.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Icmp.c
index 397296d03b15a7a28dbcbea9bb872a02e4d20c2c..757d7aadc06c0970a9fabe3a4b54c305527dea67 100644 (file)
--- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Icmp.c
+++ b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Icmp.c
@@ -1,6 +1,6 @@
 /** @file\r
 \r
-Copyright (c) 2005 - 2006, Intel Corporation\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,14 +9,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
-  Ip4Icmp.c\r
-\r
-Abstract:\r
-\r
-\r
 **/\r
 \r
 #include "Ip4Impl.h"\r
@@ -88,12 +80,12 @@ mIp4SupportedIcmp[23] = {
   message SHOULD be treated identically to a Host Redirect\r
   message;"\r
 \r
-  @param  IpSb                   The IP4 service binding instance that received the\r
-                                 packet\r
-  @param  Head                   The IP head of the received ICMPpacket.\r
-  @param  Packet                 The content of the ICMP redirect packet with IP\r
+  @param[in]  IpSb               The IP4 service binding instance that received \r
+                                 the packet.\r
+  @param[in]  Head               The IP head of the received ICMPpacket.\r
+  @param[in]  Packet             The content of the ICMP redirect packet with IP\r
                                  head removed.\r
-  @param  Icmp                   The buffer to store the ICMP error message if\r
+  @param[in]  Icmp               The buffer to store the ICMP error message if\r
                                  something is wrong.\r
 \r
   @retval EFI_INVALID_PARAMETER  The parameter is invalid\r
@@ -166,9 +158,9 @@ Ip4ProcessIcmpRedirect (
   update call Ip4ProcessIcmpRedirect to update the IP instance's\r
   route cache, otherwise, deliver the packet to upper layer.\r
 \r
-  @param  IpSb                   The IP service that received the packet.\r
-  @param  Head                   The IP head of the ICMP error packet\r
-  @param  Packet                 The content of the ICMP error with IP head\r
+  @param[in]  IpSb               The IP service that received the packet.\r
+  @param[in]  Head               The IP head of the ICMP error packet\r
+  @param[in]  Packet             The content of the ICMP error with IP head\r
                                  removed.\r
 \r
   @retval EFI_SUCCESS            The ICMP error is processed successfully.\r
@@ -208,9 +200,9 @@ Ip4ProcessIcmpError (
 /**\r
   Replay an ICMP echo request.\r
 \r
-  @param  IpSb                   The IP service that receivd the packet\r
-  @param  Head                   The IP head of the ICMP error packet\r
-  @param  Packet                 The content of the ICMP error with IP head\r
+  @param[in]  IpSb               The IP service that receivd the packet\r
+  @param[in]  Head               The IP head of the ICMP error packet\r
+  @param[in]  Packet             The content of the ICMP error with IP head\r
                                  removed.\r
 \r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate resource.\r
@@ -285,9 +277,9 @@ ON_EXIT:
   Process the ICMP query message. If it is an ICMP echo\r
   request, answer it. Otherwise deliver it to upper layer.\r
 \r
-  @param  IpSb                   The IP service that receivd the packet\r
-  @param  Head                   The IP head of the ICMP query packet\r
-  @param  Packet                 The content of the ICMP query with IP head\r
+  @param[in]  IpSb               The IP service that receivd the packet\r
+  @param[in]  Head               The IP head of the ICMP query packet\r
+  @param[in]  Packet             The content of the ICMP query with IP head\r
                                  removed.\r
 \r
   @retval EFI_INVALID_PARAMETER  The packet is invalid\r
@@ -324,9 +316,9 @@ Ip4ProcessIcmpQuery (
   then according to the message types, process it as query or\r
   error packet.\r
 \r
-  @param  IpSb                   The IP service that receivd the packet\r
-  @param  Head                   The IP head of the ICMP query packet\r
-  @param  Packet                 The content of the ICMP query with IP head\r
+  @param[in]  IpSb               The IP service that receivd the packet\r
+  @param[in]  Head               The IP head of the ICMP query packet\r
+  @param[in]  Packet             The content of the ICMP query with IP head\r
                                  removed.\r
 \r
   @retval EFI_INVALID_PARAMETER  The packet is malformated.\r