update file header

update function header 

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

1 files changed, 48 insertions, 76 deletions

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/ComponentName.c b/MdeModulePkg/Universal/Network/IScsiDxe/ComponentName.c
index bb7484e2dd..9194ab9c66 100644
--- a/MdeModulePkg/Universal/Network/IScsiDxe/ComponentName.c
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/ComponentName.c
@@ -1,7 +1,7 @@
 /** @file

-  UEFI Component Name(2) protocol implementation.

+  UEFI Component Name(2) protocol implementation for iSCSI.

 

-Copyright (c) 2004 - 2008, Intel Corporation

+Copyright (c) 2004 - 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

@@ -10,14 +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:

-

-  ComponentName.c

-

-Abstract:

-

-  ComponentName protocol for iSCSI.

-

 **/

 

 #include "IScsiImpl.h"

@@ -54,34 +46,24 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mIScsiDriverNameTable[] =
   returned in DriverName, and EFI_SUCCESS is returned. If the driver specified

   by This does not support the language specified by Language,

   then EFI_UNSUPPORTED is returned.

-

-  @param  This[in]              A pointer to the EFI_COMPONENT_NAME_PROTOCOL

-                                instance.

-

-  @param  Language[in]          A pointer to a three character ISO 639-2 language

-                                identifier.

-                                This is the language of the driver name that that

-                                the caller is requesting, and it must match one of

-                                the languages specified in SupportedLanguages.  

-                                The number of languages supported by a driver is up

-                                to the driver writer.

-

-  @param  DriverName[out]       A pointer to the Unicode string to return.

-                                This Unicode string is the name of the

-                                driver specified by This in the language

-                                specified by Language.

-

-  @retval EFI_SUCCESS           The Unicode string for the Driver specified by

-                                This and the language specified by Language was

-                                returned in DriverName.

-

+  

+  @param[in]  This        A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.

+  @param[in]  Language    A pointer to a three character ISO 639-2 language identifier.

+                          This is the language of the driver name that that the caller

+                          is requesting, and it must match one of the languages specified

+                          in SupportedLanguages.  The number of languages supported by a

+                          driver is up to the driver writer.

+  @param[out]  DriverName A pointer to the Unicode string to return.  This Unicode string

+                          is the name of the driver specified by This in the language

+                          specified by Language.

+

+  @retval EFI_SUCCESS           The Unicode string for the Driver specified by This

+                                and the language specified by Language was returned

+                                in DriverName.

   @retval EFI_INVALID_PARAMETER Language is NULL.

-

   @retval EFI_INVALID_PARAMETER DriverName is NULL.

-

-  @retval EFI_UNSUPPORTED       The driver specified by This does not support

-                                the language specified by Language.

-

+  @retval EFI_UNSUPPORTED       The driver specified by This does not support the

+                                language specified by Language.

 **/

 EFI_STATUS

 EFIAPI

@@ -102,52 +84,42 @@ IScsiComponentNameGetDriverName (
 

 /**

   Retrieves a Unicode string that is the user readable name of the controller

-  that is being managed by an EFI Driver.

-

-  @param  This[in]              A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.

-

-  @param  ControllerHandle[in]  The handle of a controller that the driver specified by

-                                This is managing.  This handle specifies the controller

-                                whose name is to be returned.

-

-  @param  ChildHandle[in]       The handle of the child controller to retrieve the name

-                                of.  This is an optional parameter that may be NULL.  It

-                                will be NULL for device drivers.  It will also be NULL

-                                for a bus drivers that wish to retrieve the name of the

-                                bus controller.  It will not be NULL for a bus driver

-                                that wishes to retrieve the name of a child controller.

-

-  @param  Language[in]          A pointer to a three character ISO 639-2 language 

-                                identifier.  This is the language of the controller name

-                                that that the caller is requesting, and it must match one

-                                of the languages specified in SupportedLanguages.  The

-                                number of languages supported by a driver is up to the

-                                driver writer.

-

-  @param  ControllerName[out]   A pointer to the Unicode string to return.  This Unicode

-                                string is the name of the controller specified by 

-                                ControllerHandle and ChildHandle in the language 

-                                specified by Language from the point of view of the 

-                                driver specified by This. 

-

-  @retval EFI_SUCCESS           The Unicode string for the user readable name in the 

-                                language specified by Language for the driver 

-                                specified by This was returned in DriverName.

-

+  that is being managed by an EFI Driver.Currently not implemented.

+

+  @param[in]  This             A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.

+  @param[in]  ControllerHandle The handle of a controller that the driver specified by

+                               This is managing.  This handle specifies the controller

+                               whose name is to be returned.

+  @param[in]  ChildHandle      The handle of the child controller to retrieve the name

+                               of.  This is an optional parameter that may be NULL.  It

+                               will be NULL for device drivers.  It will also be NULL

+                               for a bus drivers that wish to retrieve the name of the

+                               bus controller.  It will not be NULL for a bus driver

+                               that wishes to retrieve the name of a child controller.

+  @param[in]  Language         A pointer to a three character ISO 639-2 language

+                               identifier.  This is the language of the controller name

+                               that that the caller is requesting, and it must match one

+                               of the languages specified in SupportedLanguages.  The

+                               number of languages supported by a driver is up to the

+                               driver writer.

+  @param[out]  ControllerName  A pointer to the Unicode string to return.  This Unicode

+                               string is the name of the controller specified by

+                               ControllerHandle and ChildHandle in the language specified

+                               by Language from the point of view of the driver specified

+                               by This.

+

+  @retval EFI_SUCCESS           The Unicode string for the user readable name in the

+                                language specified by Language for the driver

+                                specified by This was returned in DriverName.                                

   @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.

-

   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.

-

   @retval EFI_INVALID_PARAMETER Language is NULL.

-

   @retval EFI_INVALID_PARAMETER ControllerName is NULL.

-

   @retval EFI_UNSUPPORTED       The driver specified by This is not currently managing

-                                the controller specified by ControllerHandle and ChildHandle.

-

-  @retval EFI_UNSUPPORTED       The driver specified by This does not support the 

+                                the controller specified by ControllerHandle and

+                                ChildHandle.

+  @retval EFI_UNSUPPORTED       The driver specified by This does not support the

                                 language specified by Language.

-

 **/

 EFI_STATUS

 EFIAPI