apply for doxgen format.

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

1 files changed, 30 insertions, 35 deletions

diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ComponentName.c b/MdeModulePkg/Universal/Console/ConSplitterDxe/ComponentName.c
index 45b7cf745b..927f7a5a68 100644
--- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ComponentName.c
+++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ComponentName.c
@@ -1,21 +1,16 @@
-/*++

-

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

-                                                                                          

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

+/** @file

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

 

-  ComponentName.c

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

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

 

-Abstract:

+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

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

 

---*/

+**/

 

 #include "ConSplitter.h"

 

@@ -510,40 +505,40 @@ ConSplitterAbsolutePointerComponentNameGetControllerName (
 

   Arguments:

     This             - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.

-    ControllerHandle - The handle of a controller that the driver specified by 

-                       This is managing.  This handle specifies the controller 

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

-    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 

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

-    Language         - A pointer to RFC3066 language identifier. 

-                       This is the language of the controller name 

+    Language         - A pointer to RFC3066 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 

+                       of the languages specified in SupportedLanguages.  The

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

                        driver writer.

     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. 

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

 

   Returns:

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

-                            language specified by Language for the driver 

+                            language specified by Language for the driver

                             specified by This was returned in DriverName.

     EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.

-    EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid 

+    EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid

                             EFI_HANDLE.

     EFI_INVALID_PARAMETER - Language is NULL.

     EFI_INVALID_PARAMETER - ControllerName is NULL.

-    EFI_UNSUPPORTED       - The driver specified by This is not currently 

-                            managing the controller specified by 

+    EFI_UNSUPPORTED       - The driver specified by This is not currently

+                            managing the controller specified by

                             ControllerHandle and ChildHandle.

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

+    EFI_UNSUPPORTED       - The driver specified by This does not support the

                             language specified by Language.

 

 --*/