Obsoleted by new schema and new build tools.

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

diff --git a/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.c b/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.c
index 91d6accd99bfca2b9a017c699bfccd0c5dc5202f..68c483071cfda4bce1e4ec75d675e3241718971d 100644 (file)
--- a/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.c
+++ b/EdkModulePkg/Bus/Pci/CirrusLogic/Dxe/CirrusLogic5430.c
@@ -1,20 +1,4 @@
-/*++\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.c\r
-    \r
-Abstract:\r
-\r
+/** @file\r
   Cirrus Logic 5430 Controller Driver.\r
   This driver is a sample implementation of the UGA Draw Protocol for the\r
   Cirrus Logic 5430 family of PCI video controllers.  This driver is only\r
@@ -25,9 +9,16 @@ Abstract:
   documentation on UGA for details on how to write a UGA driver that is able\r
   to function both in the EFI pre-boot environment and from the OS runtime.\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
+  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
 //\r
 // Cirrus Logic 5430 Controller Driver\r
@@ -44,6 +35,13 @@ EFI_DRIVER_BINDING_PROTOCOL gCirrusLogic5430DriverBinding = {
   NULL\r
 };\r
 \r
+/**\r
+  CirrusLogic5430ControllerDriverSupported\r
+\r
+  TODO:    This - add argument and description to function comment\r
+  TODO:    Controller - add argument and description to function comment\r
+  TODO:    RemainingDevicePath - add argument and description to function comment\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 CirrusLogic5430ControllerDriverSupported (\r
@@ -51,20 +49,6 @@ CirrusLogic5430ControllerDriverSupported (
   IN EFI_HANDLE                     Controller,\r
   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
-    None\r
-\r
---*/\r
-// TODO:    This - add argument and description to function comment\r
-// TODO:    Controller - add argument and description to function comment\r
-// TODO:    RemainingDevicePath - add argument and description to function comment\r
 {\r
   EFI_STATUS          Status;\r
   EFI_PCI_IO_PROTOCOL *PciIo;\r
@@ -139,6 +123,13 @@ Done:
   return Status;\r
 }\r
 \r
+/**\r
+  CirrusLogic5430ControllerDriverStart\r
+\r
+  TODO:    This - add argument and description to function comment\r
+  TODO:    Controller - add argument and description to function comment\r
+  TODO:    RemainingDevicePath - add argument and description to function comment\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 CirrusLogic5430ControllerDriverStart (\r
@@ -146,20 +137,6 @@ CirrusLogic5430ControllerDriverStart (
   IN EFI_HANDLE                     Controller,\r
   IN EFI_DEVICE_PATH_PROTOCOL       *RemainingDevicePath\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
-    None\r
-\r
---*/\r
-// TODO:    This - add argument and description to function comment\r
-// TODO:    Controller - add argument and description to function comment\r
-// TODO:    RemainingDevicePath - add argument and description to function comment\r
 {\r
   EFI_STATUS                      Status;\r
   CIRRUS_LOGIC_5430_PRIVATE_DATA  *Private;\r
@@ -253,6 +230,15 @@ Error:
   return Status;\r
 }\r
 \r
+/**\r
+  CirrusLogic5430ControllerDriverStop\r
+\r
+  TODO:    This - add argument and description to function comment\r
+  TODO:    Controller - add argument and description to function comment\r
+  TODO:    NumberOfChildren - add argument and description to function comment\r
+  TODO:    ChildHandleBuffer - add argument and description to function comment\r
+  TODO:    EFI_SUCCESS - add return value to function comment\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 CirrusLogic5430ControllerDriverStop (\r
@@ -261,22 +247,6 @@ CirrusLogic5430ControllerDriverStop (
   IN UINTN                          NumberOfChildren,\r
   IN EFI_HANDLE                     *ChildHandleBuffer\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
-    None\r
-\r
---*/\r
-// TODO:    This - add argument and description to function comment\r
-// TODO:    Controller - add argument and description to function comment\r
-// TODO:    NumberOfChildren - add argument and description to function comment\r
-// TODO:    ChildHandleBuffer - add argument and description to function comment\r
-// TODO:    EFI_SUCCESS - add return value to function comment\r
 {\r
   EFI_UGA_DRAW_PROTOCOL           *UgaDraw;\r
   EFI_STATUS                      Status;\r