Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/ComponentName.h b/MdePkg/Include/Protocol/ComponentName.h
index 894e6f04df8d6f626d5f5c5241a4a5873858eba4..7ac7ce0a31e088a18f3ae15694b36286666d7cd3 100644 (file)
--- a/MdePkg/Include/Protocol/ComponentName.h
+++ b/MdePkg/Include/Protocol/ComponentName.h
@@ -1,7 +1,9 @@
 /** @file\r
 /** @file\r

-  EFI Component Name Protocol\r
+  EFI Component Name Protocol as defined in the EFI 1.1 specification.\r
+  This protocol is used to retrieve user readable names of EFI Drivers \r
+  and controllers managed by EFI Drivers.\r

 \r
 \r

-  Copyright (c) 2006, 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
   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


@@ -112,6 +114,24 @@ EFI_STATUS
 //\r
 // Interface structure for the Component Name Protocol\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

 struct _EFI_COMPONENT_NAME_PROTOCOL {\r
   EFI_COMPONENT_NAME_GET_DRIVER_NAME      GetDriverName;\r
   EFI_COMPONENT_NAME_GET_CONTROLLER_NAME  GetControllerName;\r
 struct _EFI_COMPONENT_NAME_PROTOCOL {\r
   EFI_COMPONENT_NAME_GET_DRIVER_NAME      GetDriverName;\r
   EFI_COMPONENT_NAME_GET_CONTROLLER_NAME  GetControllerName;\r