Update comments to conform to the new, Doxygen friendly, coding standard. These...
authordarylm503 <darylm503@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 9 Jun 2006 23:44:26 +0000 (23:44 +0000)
committerdarylm503 <darylm503@6f19259b-4bc3-4df7-8a09-765794883524>
Fri, 9 Jun 2006 23:44:26 +0000 (23:44 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@462 6f19259b-4bc3-4df7-8a09-765794883524

EdkModulePkg/Bus/Pci/IdeBus/Dxe/ComponentName.h

index f6c3feb..4466f6a 100644 (file)
@@ -1,22 +1,14 @@
-/*++\r
-Copyright (c) 2006, 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
-http://opensource.org/licenses/bsd-license.php                                            \r
-                                                                                          \r
-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
+/** @file\r
+  Copyright (c) 2006, 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
+  http://opensource.org/licenses/bsd-license.php                                            \r
 \r
-Module Name:\r
+  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
-    ComponentName.h\r
-\r
-Abstract:\r
-\r
-\r
-Revision History\r
---*/\r
+**/\r
 \r
 #ifndef _IDE_BUS_COMPONENT_NAME_H\r
 #define _IDE_BUS_COMPONENT_NAME_H\r
@@ -38,6 +30,16 @@ extern EFI_COMPONENT_NAME_PROTOCOL  gIDEBusComponentName;
 //\r
 // EFI Component Name Functions\r
 //\r
+/**\r
+  TODO: Add function description\r
+\r
+  @param  This TODO: add argument description\r
+  @param  Language TODO: add argument description\r
+  @param  DriverName TODO: add argument description\r
+\r
+  TODO: add return values\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 IDEBusComponentNameGetDriverName (\r
@@ -45,25 +47,20 @@ IDEBusComponentNameGetDriverName (
   IN  CHAR8                        *Language,\r
   OUT CHAR16                       **DriverName\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This        - TODO: add argument description\r
-  Language    - TODO: add argument description\r
-  DriverName  - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  ControllerHandle TODO: add argument description\r
+  @param  ChildHandle TODO: add argument description\r
+  @param  Language TODO: add argument description\r
+  @param  ControllerName TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 IDEBusComponentNameGetControllerName (\r
@@ -73,46 +70,20 @@ IDEBusComponentNameGetControllerName (
   IN  CHAR8                                           *Language,\r
   OUT CHAR16                                          **ControllerName\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  This              - TODO: add argument description\r
-  ControllerHandle  - TODO: add argument description\r
-  ChildHandle       - TODO: add argument description\r
-  Language          - TODO: add argument description\r
-  ControllerName    - TODO: add argument description\r
-\r
-Returns:\r
+  @param  IdeBlkIoDevicePtr TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 VOID\r
 AddName (\r
   IN  IDE_BLK_IO_DEV               *IdeBlkIoDevicePtr\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  IdeBlkIoDevicePtr - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
---*/\r
 ;\r
 \r
 #endif\r