code scrub fix

[mirror_edk2.git] / MdeModulePkg / Universal / Network / Dhcp4Dxe / Dhcp4Option.h

diff --git a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Option.h b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Option.h
index 74d84b3f8148f2558b12c523170be8a1f6a503ea..f5be1bfa0c993aef51c3f0c94ca90444d0fa43de 100644 (file)
--- a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Option.h
+++ b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Option.h
@@ -1,6 +1,7 @@
 /** @file\r
-\r
-Copyright (c) 2006, Intel Corporation\r
+  To validate, parse and process the DHCP options.\r
+  \r
+Copyright (c) 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
-  Dhcp4Option.h\r
-\r
-Abstract:\r
-\r
-  To validate, parse and process the DHCP options\r
-\r
-\r
 **/\r
 \r
 #ifndef __EFI_DHCP4_OPTION_H__\r
@@ -233,10 +224,10 @@ EFI_STATUS
   the options in FILENAME and SERVERNAME fields. One option may be\r
   encoded in several places. See RFC 3396 Encoding Long Options in DHCP\r
 \r
-  @param  Packet                 The DHCP packet to check the options for\r
-  @param  Check                  The callback function to be called for each option\r
-                                 found\r
-  @param  Context                The opaque parameter for Check\r
+  @param[in]  Packet                 The DHCP packet to check the options for\r
+  @param[in]  Check                  The callback function to be called for each option\r
+                                     found\r
+  @param[in]  Context                The opaque parameter for Check\r
 \r
   @retval EFI_SUCCESS            The DHCP packet's options are well formated\r
   @retval EFI_INVALID_PARAMETER  The DHCP packet's options are not well formated\r
@@ -253,8 +244,8 @@ DhcpIterateOptions (
   Validate the packet's options. If necessary, allocate\r
   and fill in the interested parameters.\r
 \r
-  @param  Packet                 The packet to validate the options\r
-  @param  Para                   The variable to save the DHCP parameters.\r
+  @param[in]  Packet                 The packet to validate the options\r
+  @param[out] Para                   The variable to save the DHCP parameters.\r
 \r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory to validate the packet.\r
   @retval EFI_INVALID_PARAMETER  The options are mal-formated\r
@@ -283,11 +274,11 @@ DhcpValidateOptions (
   with DhcpFillOption to fill each option's data to its position in the\r
   buffer.\r
 \r
-  @param  Packet                 The DHCP packet to parse the options\r
-  @param  Count                  The number of valid dhcp options present in the\r
-                                 packet\r
-  @param  OptionPoint            The array that contains the DHCP options. Caller\r
-                                 should free it.\r
+  @param[in]  Packet                 The DHCP packet to parse the options\r
+  @param[out] Count                  The number of valid dhcp options present in the\r
+                                     packet\r
+  @param[out] OptionPoint            The array that contains the DHCP options. Caller\r
+                                     should free it.\r
 \r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory to parse the packet.\r
   @retval EFI_INVALID_PARAMETER  The options are mal-formated\r
@@ -305,10 +296,10 @@ DhcpParseOption (
   Append an option to the memory, if the option is longer than\r
   255 bytes, splits it into several options.\r
 \r
-  @param  Buf                    The buffer to append the option to\r
-  @param  Tag                    The option's tag\r
-  @param  DataLen                The length of the option's data\r
-  @param  Data                   The option's data\r
+  @param[out] Buf                    The buffer to append the option to\r
+  @param[in]  Tag                    The option's tag\r
+  @param[in]  DataLen                The length of the option's data\r
+  @param[in]  Data                   The option's data\r
 \r
   @return The position to append the next option\r
 \r
@@ -325,13 +316,13 @@ DhcpAppendOption (
   Build a new DHCP packet from a seed packet. Options may be deleted or\r
   appended. The caller should free the NewPacket when finished using it.\r
 \r
-  @param  SeedPacket             The seed packet to start with\r
-  @param  DeleteCount            The number of options to delete\r
-  @param  DeleteList             The options to delete from the packet\r
-  @param  AppendCount            The number of options to append\r
-  @param  AppendList             The options to append to the packet\r
-  @param  NewPacket              The new packet, allocated and built by this\r
-                                 function.\r
+  @param[in]  SeedPacket             The seed packet to start with\r
+  @param[in]  DeleteCount            The number of options to delete\r
+  @param[in]  DeleteList             The options to delete from the packet\r
+  @param[in]  AppendCount            The number of options to append\r
+  @param[in]  AppendList             The options to append to the packet\r
+  @param[out] NewPacket              The new packet, allocated and built by this\r
+                                     function.\r
 \r
   @retval EFI_OUT_OF_RESOURCES   Failed to allocate memory\r
   @retval EFI_INVALID_PARAMETER  The options in SeekPacket are mal-formated\r