code scrub fix

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7290 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 19 insertions, 32 deletions

diff --git a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Route.h b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Route.h
index 5ba2b578ef..ee1f6a907f 100644
--- a/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Route.h
+++ b/MdeModulePkg/Universal/Network/Ip4Dxe/Ip4Route.h
@@ -1,6 +1,7 @@
 /** @file

-

-Copyright (c) 2005 - 2006, Intel Corporation

+  EFI IP4 route table and route cache table defintions.

+  

+Copyright (c) 2005 - 2006, Intel Corporation.<BR>

 All rights reserved. This program and the accompanying materials

 are licensed and made available under the terms and conditions of the BSD License

 which accompanies this distribution.  The full text of the license may be found at

@@ -9,16 +10,6 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

-

-Module Name:

-

-  Ip4Route.h

-

-Abstract:

-

-  EFI IP4 route table and route cache table defintions.

-

-

 **/

 

 #ifndef __EFI_IP4_ROUTE_H__

@@ -115,9 +106,7 @@ Ip4CreateRouteTable (
   Free the route table and its associated route cache. Route

   table is reference counted.

 

-  @param  RtTable               The route table to free.

-

-  @return None

+  @param[in]  RtTable               The route table to free.

 

 **/

 VOID

@@ -129,10 +118,10 @@ Ip4FreeRouteTable (
   Add a route entry to the route table. All the IP4_ADDRs are in

   host byte order.

 

-  @param  RtTable               Route table to add route to

-  @param  Dest                  The destination of the network

-  @param  Netmask               The netmask of the destination

-  @param  Gateway               The next hop address

+  @param[in, out]  RtTable      Route table to add route to

+  @param[in]       Dest         The destination of the network

+  @param[in]       Netmask      The netmask of the destination

+  @param[in]       Gateway      The next hop address

 

   @retval EFI_ACCESS_DENIED     The same route already exists

   @retval EFI_OUT_OF_RESOURCES  Failed to allocate memory for the entry

@@ -150,10 +139,10 @@ Ip4AddRoute (
 /**

   Remove a route entry and all the route caches spawn from it.

 

-  @param  RtTable               The route table to remove the route from

-  @param  Dest                  The destination network

-  @param  Netmask               The netmask of the Dest

-  @param  Gateway               The next hop address

+  @param  RtTable           The route table to remove the route from

+  @param  Dest              The destination network

+  @param  Netmask           The netmask of the Dest

+  @param  Gateway           The next hop address

 

   @retval EFI_SUCCESS           The route entry is successfully removed

   @retval EFI_NOT_FOUND         There is no route entry in the table with that

@@ -174,9 +163,9 @@ Ip4DelRoute (
   host redirect according to RFC1122. So, only route cache entries

   are modified according to the ICMP redirect message.

 

-  @param  RtTable               The route table to search the cache for

-  @param  Dest                  The destination address

-  @param  Src                   The source address

+  @param[in]  RtTable               The route table to search the cache for

+  @param[in]  Dest                  The destination address

+  @param[in]  Src                   The source address

 

   @return NULL if no route entry to the (Dest, Src). Otherwise the point

           to the correct route cache entry.

@@ -194,8 +183,6 @@ Ip4FindRouteCache (
 

   @param  RtCacheEntry          The route cache entry to free.

 

-  @return None

-

 **/

 VOID

 Ip4FreeRouteCacheEntry (

@@ -206,9 +193,9 @@ Ip4FreeRouteCacheEntry (
   Search the route table to route the packet. Return/create a route

   cache if there is a route to the destination.

 

-  @param  RtTable               The route table to search from

-  @param  Dest                  The destination address to search for

-  @param  Src                   The source address to search for

+  @param[in]  RtTable               The route table to search from

+  @param[in]  Dest                  The destination address to search for

+  @param[in]  Src                   The source address to search for

 

   @return NULL if failed to route packet, otherwise a route cache

           entry that can be used to route packet.

@@ -226,7 +213,7 @@ Ip4Route (
   GetModeData. The EFI_IP4_ROUTE_TABLE is clumsy to use in the

   internal operation of the IP4 driver.

 

-  @param  IpInstance            The IP4 child that requests the route table.

+  @param[in]  IpInstance        The IP4 child that requests the route table.

 

   @retval EFI_SUCCESS           The route table is successfully build

   @retval EFI_OUT_OF_RESOURCES  Failed to allocate the memory for the rotue table.