update codes per MdePkg doxgen review comments.

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

diff --git a/MdePkg/Include/Protocol/ComponentName2.h b/MdePkg/Include/Protocol/ComponentName2.h
index a9562474afecb1711c8d2a2b714200f06b6e47e2..08efec6b8dce897ab48f48218e9b527a6ef8f169 100644 (file)
--- a/MdePkg/Include/Protocol/ComponentName2.h
+++ b/MdePkg/Include/Protocol/ComponentName2.h
@@ -17,8 +17,6 @@
 #ifndef __EFI_COMPONENT_NAME2_H__\r
 #define __EFI_COMPONENT_NAME2_H__\r
 \r
-#include <PiDxe.h>\r
-\r
 ///\r
 /// Global ID for the Component Name Protocol\r
 ///\r
@@ -42,7 +40,7 @@ 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
@@ -89,7 +87,7 @@ EFI_STATUS
                            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
@@ -105,7 +103,7 @@ 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
@@ -153,32 +151,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