IntelFrameworkModulePkg: Clean up source files

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / IdeBusDxe / ComponentName.h

diff --git a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/ComponentName.h b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/ComponentName.h
index f8cb60d5dc1be551f777977ff1ced22030c107a6..c5bd0432e8547eed25c4b97e0106c67c481b9ddb 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/ComponentName.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/ComponentName.h
@@ -1,6 +1,9 @@
 /** @file\r
-  Copyright (c) 2006, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
+\r
+  UEFI Component Name(2) protocol implementation header file for IDE Bus driver.\r
+\r
+  Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  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
   http://opensource.org/licenses/bsd-license.php\r
@@ -10,10 +13,10 @@
 \r
 **/\r
 \r
-#ifndef _IDE_BUS_COMPONENT_NAME_H\r
-#define _IDE_BUS_COMPONENT_NAME_H\r
+#ifndef _IDE_BUS_COMPONENT_NAME_H_\r
+#define _IDE_BUS_COMPONENT_NAME_H_\r
 \r
-#define ADD_NAME(x) AddName ((x));\r
+#define ADD_IDE_ATAPI_NAME(x) AddName ((x));\r
 \r
 extern EFI_COMPONENT_NAME_PROTOCOL   gIDEBusComponentName;\r
 extern EFI_COMPONENT_NAME2_PROTOCOL  gIDEBusComponentName2;\r
@@ -42,7 +45,7 @@ extern EFI_COMPONENT_NAME2_PROTOCOL  gIDEBusComponentName2;
                                 languages specified in SupportedLanguages. The\r
                                 number of languages supported by a driver is up\r
                                 to the driver writer. Language is specified\r
-                                in RFC 3066 or ISO 639-2 language code format.\r
+                                in RFC 4646 or ISO 639-2 language code format.\r
 \r
   @param  DriverName[out]       A pointer to the Unicode string to return.\r
                                 This Unicode string is the name of the\r
@@ -107,7 +110,7 @@ IDEBusComponentNameGetDriverName (
                                 languages specified in SupportedLanguages. The\r
                                 number of languages supported by a driver is up\r
                                 to the driver writer. Language is specified in\r
-                                RFC 3066 or ISO 639-2 language code format.\r
+                                RFC 4646 or ISO 639-2 language code format.\r
 \r
   @param  ControllerName[out]   A pointer to the Unicode string to return.\r
                                 This Unicode string is the name of the\r
@@ -121,7 +124,7 @@ IDEBusComponentNameGetDriverName (
                                 driver specified by This was returned in\r
                                 DriverName.\r
 \r
-  @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
+  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
 \r
   @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
                                 EFI_HANDLE.\r
@@ -150,11 +153,9 @@ IDEBusComponentNameGetControllerName (
 \r
 \r
 /**\r
-  TODO: Add function description\r
-\r
-  @param  IdeBlkIoDevicePtr TODO: add argument description\r
+  Add the component name for the IDE/ATAPI device\r
 \r
-  TODO: add return values\r
+  @param  IdeBlkIoDevicePtr A pointer to the IDE_BLK_IO_DEV instance.\r
 \r
 **/\r
 VOID\r