code scrub fix

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

diff --git a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Io.h b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Io.h
index 21bbf194bff216a0f9c047d3df4793b91d22d96e..5f8ac13e84ef03f88acb711083846d9fa0e3b0f9 100644 (file)
--- a/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Io.h
+++ b/MdeModulePkg/Universal/Network/Dhcp4Dxe/Dhcp4Io.h
@@ -1,6 +1,7 @@
 /** @file\r
-\r
-Copyright (c) 2006 - 2008, Intel Corporation\r
+  The DHCP4 protocol implementation.\r
+  \r
+Copyright (c) 2006 - 2008, 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
-  Dhcp4Io.h\r
-\r
-Abstract:\r
-\r
-  The DHCP4 protocol implementation.\r
-\r
-\r
 **/\r
 \r
 #ifndef __EFI_DHCP4_IO_H__\r
@@ -104,12 +95,12 @@ DhcpSetState (
   the state (as defined in Figure 5. of the same RFC) before sending\r
   a DHCP message. The table is adjusted accordingly.\r
 \r
-  @param  DhcpSb                The DHCP service instance\r
-  @param  Seed                  The seed packet which the new packet is based on\r
-  @param  Para                  The DHCP parameter of the Seed packet\r
-  @param  Type                  The message type to send\r
-  @param  Msg                   The human readable message to include in the packet\r
-                                sent.\r
+  @param[in]  DhcpSb                The DHCP service instance\r
+  @param[in]  Seed                  The seed packet which the new packet is based on\r
+  @param[in]  Para                  The DHCP parameter of the Seed packet\r
+  @param[in]  Type                  The message type to send\r
+  @param[in]  Msg                   The human readable message to include in the packet\r
+                                    sent.\r
 \r
   @retval EFI_OUT_OF_RESOURCES  Failed to allocate resources for the packet\r
   @retval EFI_ACCESS_DENIED     Failed to transmit the packet through UDP\r
@@ -133,10 +124,8 @@ DhcpSendMessage (
   and lease to determine the time to renew and rebind the lease.\r
   DhcpOnTimerTick will be called once every second.\r
 \r
-  @param  Event                 The timer event\r
-  @param  Context               The context, which is the DHCP service instance.\r
-\r
-  @return None\r
+  @param[in]  Event                 The timer event\r
+  @param[in]  Context               The context, which is the DHCP service instance.\r
 \r
 **/\r
 VOID\r
@@ -155,8 +144,6 @@ DhcpOnTimerTick (
   @param  IoStatus              The status of the UDP receive\r
   @param  Context               The opaque parameter to the function.\r
 \r
-  @return None\r
-\r
 **/\r
 VOID\r
 DhcpInput (\r
@@ -170,7 +157,7 @@ DhcpInput (
   Send an initial DISCOVER or REQUEST message according to the\r
   DHCP service's current state.\r
 \r
-  @param  DhcpSb                The DHCP service instance\r
+  @param[in]  DhcpSb                The DHCP service instance\r
 \r
   @retval EFI_SUCCESS           The request has been sent\r
   @retval other                 Some error occurs when sending the request.\r
@@ -186,8 +173,6 @@ DhcpInitRequest (
 \r
   @param  DhcpSb                The DHCP instance service.\r
 \r
-  @return None\r
-\r
 **/\r
 VOID\r
 DhcpCleanLease (\r
@@ -202,8 +187,6 @@ DhcpCleanLease (
   @param  IoStatus              The status of the UDP receive\r
   @param  Context               The opaque parameter to the function.\r
 \r
-  @return None\r
-\r
 **/\r
 VOID\r
 DhcpOnPacketSent (\r