code scrub fix

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

diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Igmp.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Igmp.h
index 7dd75740e7f30b2b4733810d2ed19e3f981cdad2..b82d3cc3ea591e11adc7ee86e835f793dd4cae3f 100644 (file)
--- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Igmp.h
+++ b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Igmp.h
@@ -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
-  Ip4Igmp.h\r
-\r
-Abstract:\r
-\r
-\r
 **/\r
 \r
 #ifndef __EFI_IP4_IGMP_H__\r
@@ -73,7 +65,7 @@ typedef enum {
   Init the IGMP control data of the IP4 service instance, configure\r
   MNP to receive ALL SYSTEM multicast.\r
 \r
-  @param  IpSb                   The IP4 service whose IGMP is to be initialized.\r
+  @param[in, out]  IpSb          The IP4 service whose IGMP is to be initialized.\r
 \r
   @retval EFI_SUCCESS            IGMP of the IpSb is successfully initialized.\r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate resource to initialize IGMP.\r
@@ -88,8 +80,8 @@ Ip4InitIgmp (
 /**\r
   Join the multicast group on behalf of this IP4 child\r
 \r
-  @param  IpInstance             The IP4 child that wants to join the group\r
-  @param  Address                The group to join\r
+  @param[in]  IpInstance         The IP4 child that wants to join the group\r
+  @param[in]  Address            The group to join\r
 \r
   @retval EFI_SUCCESS            Successfully join the multicast group\r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate resources\r
@@ -105,9 +97,9 @@ Ip4JoinGroup (
 /**\r
   Leave the IP4 multicast group on behalf of IpInstance.\r
 \r
-  @param  IpInstance             The IP4 child that wants to leave the group\r
+  @param[in]  IpInstance         The IP4 child that wants to leave the group\r
                                  address\r
-  @param  Address                The group address to leave\r
+  @param[in]  Address            The group address to leave\r
 \r
   @retval EFI_NOT_FOUND          The IP4 service instance isn't in the group\r
   @retval EFI_SUCCESS            Successfully leave the multicast group.\r
@@ -123,9 +115,9 @@ Ip4LeaveGroup (
 /**\r
   Handle the received IGMP message for the IP4 service instance.\r
 \r
-  @param  IpSb                   The IP4 service instance that received the message\r
-  @param  Head                   The IP4 header of the received message\r
-  @param  Packet                 The IGMP message, without IP4 header\r
+  @param[in]  IpSb               The IP4 service instance that received the message\r
+  @param[in]  Head               The IP4 header of the received message\r
+  @param[in]  Packet             The IGMP message, without IP4 header\r
 \r
   @retval EFI_INVALID_PARAMETER  The IGMP message is malformated.\r
   @retval EFI_SUCCESS            The IGMP message is successfully processed.\r
@@ -146,9 +138,7 @@ Ip4IgmpHandle (
   2. Decrease the report timer for each IGMP group in "delaying\r
      member" state.\r
 \r
-  @param  IpSb                   The IP4 service instance that is ticking\r
-\r
-  @return None\r
+  @param[in]  IpSb                   The IP4 service instance that is ticking\r
 \r
 **/\r
 VOID\r
@@ -163,9 +153,9 @@ Ip4IgmpTicking (
   assume the byte order of the both Source and Addr, the\r
   network byte order is used by the caller.\r
 \r
-  @param  Source                 The array of group addresses to add to\r
-  @param  Count                  The number of group addresses in the Source\r
-  @param  Addr                   The IP4 multicast address to add\r
+  @param[in]  Source                 The array of group addresses to add to\r
+  @param[in]  Count                  The number of group addresses in the Source\r
+  @param[in]  Addr                   The IP4 multicast address to add\r
 \r
   @return NULL if failed to allocate memory for the new groups,\r
           otherwise the new combined group addresses.\r
@@ -184,9 +174,9 @@ Ip4CombineGroups (
   both Groups and Addr, the network byte order is used by\r
   the caller.\r
 \r
-  @param  Groups                 The array of group addresses to remove from\r
-  @param  Count                  The number of group addresses in the Groups\r
-  @param  Addr                   The IP4 multicast address to remove\r
+  @param  Groups            The array of group addresses to remove from\r
+  @param  Count             The number of group addresses in the Groups\r
+  @param  Addr              The IP4 multicast address to remove\r
 \r
   @return The nubmer of group addresses in the Groups after remove.\r
           It is Count if the Addr isn't in the Groups.\r
@@ -203,8 +193,8 @@ Ip4RemoveGroupAddr (
   Find the IGMP_GROUP structure which contains the status of multicast\r
   group Address in this IGMP control block\r
 \r
-  @param  IgmpCtrl               The IGMP control block to search from\r
-  @param  Address                The multicast address to search\r
+  @param[in]  IgmpCtrl               The IGMP control block to search from\r
+  @param[in]  Address                The multicast address to search\r
 \r
   @return NULL if the multicast address isn't in the IGMP control block. Otherwise\r
           the point to the IGMP_GROUP which contains the status of multicast group\r