Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/ComponentName2.h b/MdePkg/Include/Protocol/ComponentName2.h
index bc6a903d154a6f795eee85354cd358966af785d3..7cec01699e0178955c4de48681b6ae7e5a2036ae 100644 (file)
--- a/MdePkg/Include/Protocol/ComponentName2.h
+++ b/MdePkg/Include/Protocol/ComponentName2.h
@@ -1,7 +1,9 @@
 /** @file\r
-  EFI Component Name 2 Protocol\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
+  and controllers managed by UEFI Drivers.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation\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
@@ -31,7 +33,7 @@ typedef struct _EFI_COMPONENT_NAME2_PROTOCOL  EFI_COMPONENT_NAME2_PROTOCOL;
   the EFI Driver.\r
 \r
   @param  This       A pointer to the\r
-                     EFI_COMPONENT_NAME_PROTOCOL instance.\r
+                     EFI_COMPONENT_NAME2_PROTOCOL instance.\r
   \r
   @param  Language   A pointer to a Null-terminated ASCII string\r
                      array indicating the language. This is the\r
@@ -76,7 +78,7 @@ EFI_STATUS
   the controller that is being managed by an EFI Driver.\r
 \r
   @param  This             A pointer to the\r
-                           EFI_COMPONENT_NAME_PROTOCOL instance.\r
+                           EFI_COMPONENT_NAME2_PROTOCOL instance.\r
 \r
   @param  ControllerHandle The handle of a controller that the\r
                            driver specified by This is managing.\r
@@ -152,8 +154,28 @@ EFI_STATUS
   );\r
 \r
 //\r
-// Interface structure for the Component Name Protocol\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
 struct _EFI_COMPONENT_NAME2_PROTOCOL {\r
   EFI_COMPONENT_NAME2_GET_DRIVER_NAME      GetDriverName;\r
   EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME  GetControllerName;\r