Insert comments for functions/macros and add the file headers.

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

1 files changed, 42 insertions, 48 deletions

diff --git a/MdeModulePkg/Universal/Network/Mtftp4Dxe/ComponentName.c b/MdeModulePkg/Universal/Network/Mtftp4Dxe/ComponentName.c
index 256d86a..36a1c19 100644
--- a/MdeModulePkg/Universal/Network/Mtftp4Dxe/ComponentName.c
+++ b/MdeModulePkg/Universal/Network/Mtftp4Dxe/ComponentName.c
@@ -1,21 +1,15 @@
 /** @file

-

-Copyright (c) 2006 - 2007, Intel Corporation

+  UEFI Component Name(2) protocol implementation for Mtftp4Dxe driver.

+  

+Copyright (c) 2006 - 2007, 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

+http://opensource.org/licenses/bsd-license.php<BR>

 

 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:

-

-

 **/

 

 #include "Mtftp4Driver.h"

@@ -33,10 +27,10 @@ Abstract:
   by This does not support the language specified by Language,

   then EFI_UNSUPPORTED is returned.

 

-  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or

+  @param[in]  This              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or

                                 EFI_COMPONENT_NAME_PROTOCOL instance.

 

-  @param  Language[in]          A pointer to a Null-terminated ASCII string

+  @param[in]  Language          A pointer to a Null-terminated ASCII string

                                 array indicating the language. This is the

                                 language of the driver name that the caller is

                                 requesting, and it must match one of the

@@ -45,7 +39,7 @@ Abstract:
                                 to the driver writer. Language is specified

                                 in RFC 3066 or ISO 639-2 language code format.

 

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

+  @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.

@@ -65,9 +59,9 @@ Abstract:
 EFI_STATUS

 EFIAPI

 Mtftp4ComponentNameGetDriverName (

-  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,

-  IN  CHAR8                        *Language,

-  OUT CHAR16                       **DriverName

+  IN     EFI_COMPONENT_NAME_PROTOCOL  *This,

+  IN     CHAR8                        *Language,

+     OUT CHAR16                       **DriverName

   );

 

 

@@ -84,15 +78,15 @@ Mtftp4ComponentNameGetDriverName (
   then EFI_UNSUPPORTED 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_NAME2_PROTOCOL or

+  @param[in]  This              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or

                                 EFI_COMPONENT_NAME_PROTOCOL instance.

 

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

+  @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  ChildHandle[in]       The handle of the child controller to retrieve

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

@@ -101,7 +95,7 @@ Mtftp4ComponentNameGetDriverName (
                                 driver that wishes to retrieve the name of a

                                 child controller.

 

-  @param  Language[in]          A pointer to a Null-terminated ASCII string

+  @param[in]  Language          A pointer to a Null-terminated ASCII string

                                 array indicating the language.  This is the

                                 language of the driver name that the caller is

                                 requesting, and it must match one of the

@@ -110,7 +104,7 @@ Mtftp4ComponentNameGetDriverName (
                                 to the driver writer. Language is specified in

                                 RFC 3066 or ISO 639-2 language code format.

 

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

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

@@ -142,26 +136,26 @@ Mtftp4ComponentNameGetDriverName (
 EFI_STATUS

 EFIAPI

 Mtftp4ComponentNameGetControllerName (

-  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,

-  IN  EFI_HANDLE                                      ControllerHandle,

-  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,

-  IN  CHAR8                                           *Language,

-  OUT CHAR16                                          **ControllerName

+  IN     EFI_COMPONENT_NAME_PROTOCOL               *This,

+  IN     EFI_HANDLE                                ControllerHandle,

+  IN     EFI_HANDLE                                ChildHandle        OPTIONAL,

+  IN     CHAR8                                     *Language,

+     OUT CHAR16                                    **ControllerName

   );

 

 

-//

-// EFI Component Name Protocol

-//

+///

+/// EFI Component Name Protocol

+///

 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL  gMtftp4ComponentName = {

   Mtftp4ComponentNameGetDriverName,

   Mtftp4ComponentNameGetControllerName,

   "eng"

 };

 

-//

-// EFI Component Name 2 Protocol

-//

+///

+/// EFI Component Name 2 Protocol

+///

 GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gMtftp4ComponentName2 = {

   (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) Mtftp4ComponentNameGetDriverName,

   (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) Mtftp4ComponentNameGetControllerName,

@@ -190,10 +184,10 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mMtftp4DriverNameTable[]
   by This does not support the language specified by Language,

   then EFI_UNSUPPORTED is returned.

 

-  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or

+  @param[in]  This              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or

                                 EFI_COMPONENT_NAME_PROTOCOL instance.

 

-  @param  Language[in]          A pointer to a Null-terminated ASCII string

+  @param[in]  Language          A pointer to a Null-terminated ASCII string

                                 array indicating the language. This is the

                                 language of the driver name that the caller is

                                 requesting, and it must match one of the

@@ -202,7 +196,7 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mMtftp4DriverNameTable[]
                                 to the driver writer. Language is specified

                                 in RFC 3066 or ISO 639-2 language code format.

 

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

+  @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.

@@ -222,9 +216,9 @@ GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mMtftp4DriverNameTable[]
 EFI_STATUS

 EFIAPI

 Mtftp4ComponentNameGetDriverName (

-  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,

-  IN  CHAR8                        *Language,

-  OUT CHAR16                       **DriverName

+  IN     EFI_COMPONENT_NAME_PROTOCOL  *This,

+  IN     CHAR8                        *Language,

+     OUT CHAR16                       **DriverName

   )

 {

   return LookupUnicodeString2 (

@@ -249,15 +243,15 @@ Mtftp4ComponentNameGetDriverName (
   then EFI_UNSUPPORTED 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_NAME2_PROTOCOL or

+  @param[in]  This              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or

                                 EFI_COMPONENT_NAME_PROTOCOL instance.

 

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

+  @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  ChildHandle[in]       The handle of the child controller to retrieve

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

@@ -266,7 +260,7 @@ Mtftp4ComponentNameGetDriverName (
                                 driver that wishes to retrieve the name of a

                                 child controller.

 

-  @param  Language[in]          A pointer to a Null-terminated ASCII string

+  @param[in]  Language          A pointer to a Null-terminated ASCII string

                                 array indicating the language.  This is the

                                 language of the driver name that the caller is

                                 requesting, and it must match one of the

@@ -275,7 +269,7 @@ Mtftp4ComponentNameGetDriverName (
                                 to the driver writer. Language is specified in

                                 RFC 3066 or ISO 639-2 language code format.

 

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

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

@@ -307,11 +301,11 @@ Mtftp4ComponentNameGetDriverName (
 EFI_STATUS

 EFIAPI

 Mtftp4ComponentNameGetControllerName (

-  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,

-  IN  EFI_HANDLE                                      ControllerHandle,

-  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,

-  IN  CHAR8                                           *Language,

-  OUT CHAR16                                          **ControllerName

+  IN     EFI_COMPONENT_NAME_PROTOCOL               *This,

+  IN     EFI_HANDLE                                ControllerHandle,

+  IN     EFI_HANDLE                                ChildHandle        OPTIONAL,

+  IN     CHAR8                                     *Language,

+     OUT CHAR16                                    **ControllerName

   )

 {

   return EFI_UNSUPPORTED;