code scrub fix

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

diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c
index 334bb41112aa7dd0699e8b309da291dcef78d46d..72dbb8c1cd0d2a4f36b8f58b3a88bcd4f0f7d05f 100644 (file)
--- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c
+++ b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Option.c
@@ -1,6 +1,7 @@
 /** @file\r
-\r
-Copyright (c) 2005 - 2006, Intel Corporation\r
+  IP4 option support functions.\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,15 +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
-Module Name:\r
-\r
-  Ip4Option.c\r
-\r
-Abstract:\r
-\r
-  IP4 option support functions\r
-\r
-\r
 **/\r
 \r
 #include "Ip4Impl.h"\r
@@ -28,9 +20,9 @@ Abstract:
   and will transmit. It will compute the ICMP error message fields\r
   if the option is mal-formated. But this information isn't used.\r
 \r
-  @param  Option                The first byte of the option\r
-  @param  OptionLen             The length of the whole option\r
-  @param  Rcvd                  The option is from the packet we received if TRUE,\r
+  @param[in]  Option            The first byte of the option\r
+  @param[in]  OptionLen         The length of the whole option\r
+  @param[in]  Rcvd              The option is from the packet we received if TRUE,\r
                                 otherwise the option we wants to transmit.\r
 \r
   @retval TRUE     The option is properly formatted\r
@@ -127,11 +119,11 @@ Ip4OptionIsValid (
      fragments.\r
   2. Pad the options copied over to aligned to 4 bytes.\r
 \r
-  @param  Option                The original option to copy from\r
-  @param  OptionLen             The length of the original option\r
-  @param  FirstFragment         Whether it is the first fragment\r
-  @param  Buf                   The buffer to copy options to. NULL \r
-  @param  BufLen                The length of the buffer\r
+  @param[in]       Option            The original option to copy from\r
+  @param[in]       OptionLen         The length of the original option\r
+  @param[in]       FirstFragment     Whether it is the first fragment\r
+  @param[in, out]  Buf               The buffer to copy options to. NULL \r
+  @param[in, out]  BufLen            The length of the buffer\r
 \r
   @retval EFI_SUCCESS           The options are copied over\r
   @retval EFI_BUFFER_TOO_SMALL  Buf is NULL or BufLen provided is too small.\r