MdePkg: Clean up source files

[mirror_edk2.git] / MdePkg / Include / Protocol / ComponentName2.h

diff --git a/MdePkg/Include/Protocol/ComponentName2.h b/MdePkg/Include/Protocol/ComponentName2.h
index 45b2a8a8817eb6b90ca5a1eb184c6d808118dd51..f02183e4c4985bd7bcee06c69784d728bc7d0b19 100644 (file)
--- a/MdePkg/Include/Protocol/ComponentName2.h
+++ b/MdePkg/Include/Protocol/ComponentName2.h
@@ -1,16 +1,16 @@
 /** @file\r
   UEFI Component Name 2 Protocol as defined in the UEFI 2.1 specification.\r
-  This protocol is used to retrieve user readable names of drivers \r
+  This protocol is used to retrieve user readable names of drivers\r
   and controllers managed by UEFI Drivers.\r
 \r
-  Copyright (c) 2006 - 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) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  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
 \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
+  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
 **/\r
 \r
@@ -27,12 +27,12 @@ typedef struct _EFI_COMPONENT_NAME2_PROTOCOL  EFI_COMPONENT_NAME2_PROTOCOL;
 \r
 \r
 /**\r
-  Retrieves a Unicode string that is the user-readable name of\r
+  Retrieves a string that is the user readable name of\r
   the EFI Driver.\r
 \r
   @param  This       A pointer to the\r
                      EFI_COMPONENT_NAME2_PROTOCOL instance.\r
-  \r
+\r
   @param  Language   A pointer to a Null-terminated ASCII string\r
                      array indicating the language. This is the\r
                      language of the driver name that the caller\r
@@ -42,21 +42,21 @@ typedef struct _EFI_COMPONENT_NAME2_PROTOCOL  EFI_COMPONENT_NAME2_PROTOCOL;
                      driver is up to the driver writer. Language\r
                      is specified in RFC 4646 language code\r
                      format.\r
-  \r
-  @param  DriverName A pointer to the Unicode string to return.\r
-                     This Unicode string is the name of the\r
+\r
+  @param  DriverName A pointer to the string to return.\r
+                     This string is the name of the\r
                      driver specified by This in the language\r
                      specified by Language.\r
 \r
-  @retval EFI_SUCCESS           The Unicode string for the\r
+  @retval EFI_SUCCESS           The string for the\r
                                 Driver specified by This and the\r
                                 language specified by Language\r
                                 was returned in DriverName.\r
-  \r
+\r
   @retval EFI_INVALID_PARAMETER Language is NULL.\r
-  \r
+\r
   @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
-  \r
+\r
   @retval EFI_UNSUPPORTED       The driver specified by This\r
                                 does not support the language\r
                                 specified by Language.\r
@@ -72,7 +72,7 @@ EFI_STATUS
 \r
 \r
 /**\r
-  Retrieves a Unicode string that is the user readable name of\r
+  Retrieves a string that is the user readable name of\r
   the controller that is being managed by an EFI Driver.\r
 \r
   @param  This             A pointer to the\r
@@ -83,7 +83,7 @@ EFI_STATUS
                            This handle specifies the controller\r
                            whose name is to be returned.\r
 \r
-  @param ChildHandle      The handle of the child controller to\r
+  @param  ChildHandle      The handle of the child controller to\r
                            retrieve the name of.  This is an\r
                            optional parameter that may be NULL.\r
                            It will be NULL for device drivers.\r
@@ -106,22 +106,20 @@ EFI_STATUS
                            specified in RFC 4646 language code\r
                            format.\r
 \r
-  @param  ControllerName   A pointer to the Unicode string to\r
-                           return.  This Unicode string is the\r
-                           name of the controller specified by\r
-                           ControllerHandle and ChildHandle in\r
-                           the language specified by Language\r
+  @param  ControllerName   A pointer to the string to return.\r
+                           This string is the name of the controller\r
+                           specified by ControllerHandle and ChildHandle\r
+                           in the language specified by Language\r
                            from the point of view of the driver\r
                            specified by This.\r
 \r
-  @retval EFI_SUCCESS           The Unicode string for the user\r
+  @retval EFI_SUCCESS           The string for the user\r
                                 readable name in the language\r
                                 specified by Language for the\r
                                 driver specified by This was\r
                                 returned in DriverName.\r
 \r
-  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid\r
-                                EFI_HANDLE.\r
+  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
 \r
   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it\r
                                 is not a valid EFI_HANDLE.\r
@@ -152,7 +150,7 @@ EFI_STATUS
   );\r
 \r
 ///\r
-/// This protocol is used to retrieve user readable names of drivers \r
+/// This protocol is used to retrieve user readable names of drivers\r
 /// and controllers managed by UEFI Drivers.\r
 ///\r
 struct _EFI_COMPONENT_NAME2_PROTOCOL {\r
@@ -164,7 +162,7 @@ struct _EFI_COMPONENT_NAME2_PROTOCOL {
   /// supported language codes. This is the list of language codes that\r
   /// this protocol supports. The number of languages supported by a\r
   /// driver is up to the driver writer. SupportedLanguages is\r
-  /// specified in RFC 4646 format.  \r
+  /// specified in RFC 4646 format.\r
   ///\r
   CHAR8                                    *SupportedLanguages;\r
 };\r