]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/ComponentName.h
Reviewed the description in the FatBinPkg .dec file.
[mirror_edk2.git] / MdePkg / Include / Protocol / ComponentName.h
index 7ac7ce0a31e088a18f3ae15694b36286666d7cd3..1f0f5f1749b8ff8f665be9a4bfbcd308bda69b3e 100644 (file)
 #ifndef __EFI_COMPONENT_NAME_H__\r
 #define __EFI_COMPONENT_NAME_H__\r
 \r
-#include <PiDxe.h>\r
-\r
-//\r
-// Global ID for the Component Name Protocol\r
-//\r
+///\r
+/// Global ID for the Component Name Protocol\r
+///\r
 #define EFI_COMPONENT_NAME_PROTOCOL_GUID \\r
   { \\r
     0x107a772c, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
@@ -111,30 +109,18 @@ EFI_STATUS
   OUT CHAR16                                                  **ControllerName\r
   );\r
 \r
-//\r
-// Interface structure for the Component Name 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 that contains one or more\r
-  ISO 639-2 language codes. This is the list of language codes\r
-  that this protocol supports.\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_NAME_PROTOCOL {\r
   EFI_COMPONENT_NAME_GET_DRIVER_NAME      GetDriverName;\r
   EFI_COMPONENT_NAME_GET_CONTROLLER_NAME  GetControllerName;\r
+  ///\r
+  /// A Null-terminated ASCII string that contains one or more\r
+  /// ISO 639-2 language codes. This is the list of language codes\r
+  /// that this protocol supports.  \r
+  ///\r
   CHAR8                                   *SupportedLanguages;\r
 };\r
 \r