Reviewed the code comments in the Include/Protocol directory for typos, grammar issue...

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

diff --git a/MdePkg/Include/Protocol/ComponentName2.h b/MdePkg/Include/Protocol/ComponentName2.h
index 1ee87e9a75f5f245a060b0647f0beabfee15add8..45b2a8a8817eb6b90ca5a1eb184c6d808118dd51 100644 (file)
--- a/MdePkg/Include/Protocol/ComponentName2.h
+++ b/MdePkg/Include/Protocol/ComponentName2.h
@@ -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 Unicode string that is the user-readable name of\r
   the EFI Driver.\r
 \r
   @param  This       A pointer to the\r
@@ -40,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
@@ -87,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
@@ -103,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
@@ -151,14 +151,10 @@ 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
+///\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
@@ -168,7 +164,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 3066 format.  \r
+  /// specified in RFC 4646 format.  \r
   ///\r
   CHAR8                                    *SupportedLanguages;\r
 };\r