Update comments to conform to the new, Doxygen friendly, coding standard. These...

[mirror_edk2.git] / EdkModulePkg / Bus / Pci / CirrusLogic / Dxe / CirrusLogic5430.h

diff --git a/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.h b/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.h
index 79ca7e0293d1295c1dfb7d42256db8d697864eb6..b1984c8865473d578f7fa25924046f88f3881647 100644 (file)
--- a/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.h
+++ b/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.h
@@ -1,25 +1,16 @@
-/*++\r
-\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
-\r
-Module Name:\r
-\r
-  CirrusLogic5430.h\r
-    \r
-Abstract:\r
-\r
+/** @file\r
   Cirrus Logic 5430 Controller Driver\r
 \r
-Revision History\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
---*/\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
+**/\r
 \r
 //\r
 // Cirrus Logic 5430 Controller Driver\r
@@ -99,78 +90,67 @@ extern EFI_COMPONENT_NAME_PROTOCOL  gCirrusLogic5430ComponentName;
 //\r
 // UGA Draw Hardware abstraction internal worker functions\r
 //\r
+/**\r
+  TODO: Add function description\r
+\r
+  @param  Private TODO: add argument description\r
+\r
+  TODO: add return values\r
+\r
+**/\r
 EFI_STATUS\r
 CirrusLogic5430UgaDrawConstructor (\r
   CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  Private - TODO: add argument description\r
-\r
-Returns:\r
+  @param  Private TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 CirrusLogic5430UgaDrawDestructor (\r
   CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+//\r
+// EFI 1.1 driver model prototypes for Cirrus Logic 5430 UGA Draw\r
+//\r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  Private - TODO: add argument description\r
-\r
-Returns:\r
+  @param  ImageHandle TODO: add argument description\r
+  @param  SystemTable TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
-//\r
-// EFI 1.1 driver model prototypes for Cirrus Logic 5430 UGA Draw\r
-//\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 CirrusLogic5430DriverEntryPoint (\r
   IN EFI_HANDLE        ImageHandle,\r
   IN EFI_SYSTEM_TABLE  *SystemTable\r
   )\r
-/*++\r
-\r
-Routine Description:\r
+;\r
 \r
+//\r
+// EFI_DRIVER_BINDING_PROTOCOL Protocol Interface\r
+//\r
+/**\r
   TODO: Add function description\r
 \r
-Arguments:\r
-\r
-  ImageHandle - TODO: add argument description\r
-  SystemTable - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  Controller TODO: add argument description\r
+  @param  RemainingDevicePath TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
-//\r
-// EFI_DRIVER_BINDING_PROTOCOL Protocol Interface\r
-//\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 CirrusLogic5430ControllerDriverSupported (\r
@@ -178,25 +158,18 @@ CirrusLogic5430ControllerDriverSupported (
   IN EFI_HANDLE                   Controller,\r
   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\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
-  Controller          - TODO: add argument description\r
-  RemainingDevicePath - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  Controller TODO: add argument description\r
+  @param  RemainingDevicePath TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 CirrusLogic5430ControllerDriverStart (\r
@@ -204,25 +177,19 @@ CirrusLogic5430ControllerDriverStart (
   IN EFI_HANDLE                   Controller,\r
   IN EFI_DEVICE_PATH_PROTOCOL     *RemainingDevicePath\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
-  Controller          - TODO: add argument description\r
-  RemainingDevicePath - TODO: add argument description\r
-\r
-Returns:\r
+  @param  This TODO: add argument description\r
+  @param  Controller TODO: add argument description\r
+  @param  NumberOfChildren TODO: add argument description\r
+  @param  ChildHandleBuffer TODO: add argument description\r
 \r
   TODO: add return values\r
 \r
---*/\r
-;\r
-\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 CirrusLogic5430ControllerDriverStop (\r
@@ -231,24 +198,6 @@ CirrusLogic5430ControllerDriverStop (
   IN UINTN                        NumberOfChildren,\r
   IN EFI_HANDLE                   *ChildHandleBuffer\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  This              - TODO: add argument description\r
-  Controller        - TODO: add argument description\r
-  NumberOfChildren  - TODO: add argument description\r
-  ChildHandleBuffer - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
---*/\r
 ;\r
 \r
 #endif\r