Change the file headers and some function comments.

[mirror_edk2.git] / MdeModulePkg / Universal / Network / MnpDxe / MnpDriver.c

diff --git a/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.c b/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.c
index b6c0138b517ed54b29131c052f51e193a3ef3876..d4aaac33bd716aa8bd1523ea188d3f4f4627a288 100644 (file)
--- a/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.c
+++ b/MdeModulePkg/Universal/Network/MnpDxe/MnpDriver.c
@@ -1,21 +1,15 @@
 /** @file\r
+    Implementation of driver entry point and driver binding protocol.\r
 \r
-Copyright (c) 2005 - 2008, Intel Corporation\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
-http://opensource.org/licenses/bsd-license.php\r
+Copyright (c) 2005 - 2008, Intel Corporation. <BR> \r
+All rights reserved. This program and the accompanying materials are licensed \r
+and made available under the terms and conditions of the BSD License which \r
+accompanies this distribution. The full text of the license may be found at \r
+http://opensource.org/licenses/bsd-license.php \r
 \r
 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
-  MnpDriver.c\r
-\r
-Abstract:\r
-\r
-\r
 **/\r
 \r
 #include "MnpDriver.h"\r
@@ -284,10 +278,10 @@ MnpDriverBindingStop (
                                  not NULL, then the I/O services are  added to the\r
                                  existing child handle.\r
 \r
-  @retval EFI_SUCCES             The child handle was created with the I/O\r
-                                 services.\r
-  @retval EFI_OUT_OF_RESOURCES   There are not enough resources availabe to create\r
-                                 the child.\r
+  @retval EFI_SUCCES             The protocol was added to ChildHandle. \r
+  @retval EFI_INVALID_PARAMETER  ChildHandle is NULL. \r
+  @retval EFI_OUT_OF_RESOURCES   There are not enough resources availabe to \r
+                                 create the child.\r
   @retval other                  The child handle was not created.\r
 \r
 **/\r
@@ -295,7 +289,7 @@ EFI_STATUS
 EFIAPI\r
 MnpServiceBindingCreateChild (\r
   IN EFI_SERVICE_BINDING_PROTOCOL  *This,\r
-  IN EFI_HANDLE                    *ChildHandle\r
+  IN OUT EFI_HANDLE                *ChildHandle\r
   )\r
 {\r
   EFI_STATUS         Status;\r
@@ -391,17 +385,22 @@ ErrorExit:
 \r
 /**\r
   Destroys a child handle with a set of I/O services.\r
-\r
-  @param  This                   Protocol instance pointer.\r
+   \r
+  The DestroyChild() function does the opposite of CreateChild(). It removes a \r
+  protocol that was installed by CreateChild() from ChildHandle. If the removed \r
+  protocol is the last protocol on ChildHandle, then ChildHandle is destroyed. \r
+   \r
+  @param  This                   Pointer to the EFI_SERVICE_BINDING_PROTOCOL \r
+                                 instance.\r
   @param  ChildHandle            Handle of the child to destroy.\r
 \r
-  @retval EFI_SUCCES             The I/O services were removed from the child\r
-                                 handle.\r
-  @retval EFI_UNSUPPORTED        The child handle does not support the I/O services\r
-                                  that are being removed.\r
-  @retval EFI_INVALID_PARAMETER  Child handle is not a valid EFI Handle.\r
-  @retval EFI_ACCESS_DENIED      The child handle could not be destroyed because\r
-                                 its  I/O services are being used.\r
+  @retval EFI_SUCCES             The protocol was removed from ChildHandle. \r
+  @retval EFI_UNSUPPORTED        ChildHandle does not support the protocol that\r
+                                 is being removed.\r
+  @retval EFI_INVALID_PARAMETER  ChildHandle is not a valid UEFI handle.\r
+  @retval EFI_ACCESS_DENIED      The protocol could not be removed from the\r
+                                 ChildHandle because its services are being\r
+                                 used.\r
   @retval other                  The child handle was not destroyed.\r
 \r
 **/\r
@@ -524,7 +523,7 @@ MnpServiceBindingDestroyChild (
   @param  ImageHandle   The image handle of the driver.\r
   @param  SystemTable   The system table.\r
 \r
-  @retval EFI_SUCCES       the driver binding and component name protocols are \r
+  @retval EFI_SUCCES       The driver binding and component name protocols are \r
                            successfully installed.\r
   @retval other            failed.\r
 \r