Update comments for Protocol definitions to match UEFI spec.

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

diff --git a/MdePkg/Include/Protocol/ComponentName.h b/MdePkg/Include/Protocol/ComponentName.h
index 68fd31ba8b3064df53fabc676a81860860c02596..1f0f5f1749b8ff8f665be9a4bfbcd308bda69b3e 100644 (file)
--- a/MdePkg/Include/Protocol/ComponentName.h
+++ b/MdePkg/Include/Protocol/ComponentName.h
@@ -1,7 +1,9 @@
 /** @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
-  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
@@ -10,16 +12,14 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  ComponentName.h\r
-\r
 **/\r
 \r
 #ifndef __EFI_COMPONENT_NAME_H__\r
 #define __EFI_COMPONENT_NAME_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
@@ -52,7 +52,7 @@ typedef struct _EFI_COMPONENT_NAME_PROTOCOL  EFI_COMPONENT_NAME_PROTOCOL;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_COMPONENT_NAME_GET_DRIVER_NAME) (\r
+(EFIAPI *EFI_COMPONENT_NAME_GET_DRIVER_NAME)(\r
   IN EFI_COMPONENT_NAME_PROTOCOL           *This,\r
   IN  CHAR8                                *Language,\r
   OUT CHAR16                               **DriverName\r
@@ -101,7 +101,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_COMPONENT_NAME_GET_CONTROLLER_NAME) (\r
+(EFIAPI *EFI_COMPONENT_NAME_GET_CONTROLLER_NAME)(\r
   IN EFI_COMPONENT_NAME_PROTOCOL                              *This,\r
   IN  EFI_HANDLE                                              ControllerHandle,\r
   IN  EFI_HANDLE                                              ChildHandle        OPTIONAL,\r
@@ -109,12 +109,18 @@ EFI_STATUS
   OUT CHAR16                                                  **ControllerName\r
   );\r
 \r
-//\r
-// Interface structure for the Component Name Protocol\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