Change the file headers and some function comments.

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

1 files changed, 25 insertions, 32 deletions

diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c b/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c
index e29f0978f1..94bbe18847 100644
--- a/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c
+++ b/MdeModulePkg/Universal/Network/MnpDxe/MnpConfig.c
@@ -1,23 +1,15 @@
 /** @file

+  Implementation of Managed Network Protocol private services.

 

-Copyright (c) 2005 - 2008, Intel Corporation

-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

-http://opensource.org/licenses/bsd-license.php

+Copyright (c) 2005 - 2008, 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 

+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:

-

-  MnpConfig.c

-

-Abstract:

-

-  Implementation of Managed Network Protocol private services.

-

-

 **/

 

 

@@ -59,8 +51,8 @@ EFI_MANAGED_NETWORK_CONFIG_DATA mMnpDefaultConfigData = {
   @param  MnpServiceData        Pointer to the mnp service context data.

 

   @retval EFI_SUCCESS           The receive filters is configured.

-  @retval EFI_OUT_OF_RESOURCES  The receive filters can't be configured due to lack

-                                of memory resource.

+  @retval EFI_OUT_OF_RESOURCES  The receive filters can't be configured due to 

+                                lack of memory resource.

 

 **/

 EFI_STATUS

@@ -210,14 +202,14 @@ MnpConfigReceiveFilters (
 }

 

 /**

-  Add some NET_BUF into MnpServiceData->FreeNbufQue. The buffer length of

-  the NET_BUF is specified by MnpServiceData->BufferLength.

+  Add Count of net buffers to MnpServiceData->FreeNbufQue. The length of the net

+  buffer is specified by MnpServiceData->BufferLength. 

 

   @param  MnpServiceData        Pointer to the MNP_SERVICE_DATA.

   @param  Count                 Number of NET_BUFFERs to add.

 

-  @retval EFI_SUCCESS           The specified amount of NET_BUFs are allocated and

-                                added into MnpServiceData->FreeNbufQue.

+  @retval EFI_SUCCESS           The specified amount of NET_BUFs are allocated 

+                                and added to MnpServiceData->FreeNbufQue.

   @retval EFI_OUT_OF_RESOURCES  Failed to allocate a NET_BUF structure.

 

 **/

@@ -270,7 +262,8 @@ MnpAddFreeNbuf (
 

   @param  MnpServiceData        Pointer to the MNP_SERVICE_DATA.

 

-  @return Pointer to the allocated free NET_BUF structure, if NULL the operation is failed.

+  @return     Pointer to the allocated free NET_BUF structure, if NULL the 

+              operation is failed.

 

 **/

 NET_BUF *

@@ -712,21 +705,21 @@ MnpTokenExist (
 /**

   Cancel the token specified by Arg if it matches the token in Item.

 

-  @param  Map                   Pointer to the NET_MAP.

-  @param  Item                  Pointer to the NET_MAP_ITEM

-  @param  Arg                   Pointer to the Arg, it's a pointer to the token to

-                                cancel.

+  @param  Map               Pointer to the NET_MAP.

+  @param  Item              Pointer to the NET_MAP_ITEM

+  @param  Arg               Pointer to the Arg, it's a pointer to the token to 

+                            cancel.

 

-  @retval EFI_SUCCESS           The Arg is NULL, and the token in Item is

-                                cancelled, or the Arg isn't NULL, and the token in

-                                Item is different from the Arg.

-  @retval EFI_ABORTED           The Arg isn't NULL, the token in Item mathces the

-                                Arg, and the token is cancelled.

+  @retval EFI_SUCCESS       The Arg is NULL, and the token in Item is cancelled, 

+                            or the Arg isn't NULL, and the token in Item is

+                            different from the Arg.

+  @retval EFI_ABORTED       The Arg isn't NULL, the token in Item mathces the

+                            Arg, and the token is cancelled.

 

 **/

 EFI_STATUS

 MnpCancelTokens (

-  IN NET_MAP       *Map,

+  IN OUT NET_MAP   *Map,

   IN NET_MAP_ITEM  *Item,

   IN VOID          *Arg

   )

@@ -838,7 +831,7 @@ MnpStopSnp (
 

   @param  MnpServiceData        Pointer to the mnp service context data.

   @param  IsConfigUpdate        The instance is reconfigured or it's the first time

-                                 the instanced is configured.

+                                the instanced is configured.

   @param  EnableSystemPoll      Enable the system polling or not.

 

   @retval EFI_SUCCESS           The managed network is started and some