Fix the comments in the core interface to follow the UEFI Spec regarding how to check...

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

diff --git a/MdePkg/Include/Protocol/ComponentName2.h b/MdePkg/Include/Protocol/ComponentName2.h
index fa5c7a841051aa73b841126bfd56838cb747c78f..b4e8a4d9a4a5587af43d690c151ba765edc2bc37 100644 (file)
--- a/MdePkg/Include/Protocol/ComponentName2.h
+++ b/MdePkg/Include/Protocol/ComponentName2.h
@@ -3,8 +3,8 @@
   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
+  Copyright (c) 2006 - 2011, 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
@@ -27,7 +27,7 @@ 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
@@ -40,15 +40,15 @@ typedef struct _EFI_COMPONENT_NAME2_PROTOCOL  EFI_COMPONENT_NAME2_PROTOCOL;
                      languages specified in SupportedLanguages.\r
                      The number of languages supported by a\r
                      driver is up to the driver writer. Language\r
-                     is specified in RFC 3066 language code\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
+  @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
@@ -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,11 +83,11 @@ 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
-                           It will also be NULL for a bus\r
+                           It will also be NULL for bus\r
                            drivers that wish to retrieve the\r
                            name of the bus controller.  It will\r
                            not be NULL for a bus driver that\r
@@ -103,25 +103,23 @@ EFI_STATUS
                            SupportedLanguages. The number of\r
                            languages supported by a driver is up\r
                            to the driver writer. Language is\r
-                           specified in RFC 3066 language code\r
+                           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
@@ -151,32 +149,21 @@ EFI_STATUS
   OUT CHAR16                      **ControllerName\r
   );\r
 \r
-//\r
-// Interface structure for the Component Name2 Protocol\r
-//\r
-/**\r
-  @par Protocol Description:\r
-  This protocol is used to retrieve user readable names of drivers \r
-  and controllers managed by UEFI Drivers.\r
-\r
-  @param GetDriverName\r
-  Retrieves a Unicode string that is the user readable name of the driver.\r
-  \r
-  @param GetControllerName\r
-  Retrieves a Unicode string that is the user readable name of a\r
-  controller that is being managed by a driver.\r
-  \r
-  @param SupportedLanguages \r
-  A Null-terminated ASCII string array that contains one or more\r
-  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 3066 format.\r
-  \r
-**/\r
+///\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
   EFI_COMPONENT_NAME2_GET_DRIVER_NAME      GetDriverName;\r
   EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME  GetControllerName;\r
+\r
+  ///\r
+  /// A Null-terminated ASCII string array that contains one or more\r
+  /// 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
+  ///\r
   CHAR8                                    *SupportedLanguages;\r
 };\r
 \r