From 81ebe5ae885ec6d48d947be105a67221a0403d32 Mon Sep 17 00:00:00 2001 From: marschap Date: Sun, 21 Dec 2008 10:04:37 +0000 Subject: [PATCH] first step in Doxygen-ization --- server/drivers/CFontz.c | 4 ++++ server/drivers/CFontz633.c | 4 ++++ server/drivers/CFontzPacket.c | 5 +++++ server/drivers/EyeboxOne.c | 5 +++++ server/drivers/MD8800.c | 5 ++++- server/drivers/MtxOrb.c | 4 ++++ server/drivers/NoritakeVFD.c | 5 ++++- server/drivers/adv_bignum.c | 7 ++++++- server/drivers/bayrad.c | 4 ++++ server/drivers/ea65.c | 4 ++++ server/drivers/g15.c | 5 ++++- server/drivers/glcdlib.c | 4 ++++ server/drivers/glk.c | 4 ++++ server/drivers/hd44780.c | 2 +- server/drivers/i2500vfd.c | 4 ++++ server/drivers/icp_a106.c | 5 ++++- server/drivers/imon.c | 6 +++++- server/drivers/irmanin.c | 4 ++++ server/drivers/irtrans.c | 7 ++++--- server/drivers/joy.c | 4 ++++ server/drivers/lb216.c | 5 ++++- server/drivers/lcdm001.c | 6 ++++-- server/drivers/lcterm.c | 9 +++++---- server/drivers/lircin.c | 5 ++++- server/drivers/lis.c | 4 ++++ server/drivers/ms6931.c | 4 ++++ server/drivers/mtc_s16209x.c | 4 ++++ server/drivers/mx5000.c | 5 ++++- server/drivers/picolcd.c | 6 ++++-- server/drivers/pylcd.c | 5 +++-- server/drivers/sed1330.c | 4 ++++ server/drivers/sed1520.c | 4 ++++ server/drivers/serialPOS.c | 5 +++++ server/drivers/serialVFD.c | 5 ++++- server/drivers/shuttleVFD.c | 6 ++++-- server/drivers/stv5730.c | 5 +++++ server/drivers/svgalib_drv.c | 4 ++++ server/drivers/t6963.c | 4 ++++ server/drivers/tyan_lcdm.c | 5 ++++- server/drivers/ula200.c | 4 ++++ server/drivers/wirz-sli.c | 4 ++++ server/drivers/xosdlib_drv.c | 3 +-- 42 files changed, 169 insertions(+), 29 deletions(-) diff --git a/server/drivers/CFontz.c b/server/drivers/CFontz.c index c86a319..fe2f004 100644 --- a/server/drivers/CFontz.c +++ b/server/drivers/CFontz.c @@ -1,3 +1,7 @@ +/** \file server/drivers/CFontz.c + * LCDd \c CFontz driver for the CFA632 & CFA634 displays by CrystalFontz, Inc. + */ + /* This is the LCDproc driver for CrystalFontz devices (http://crystalfontz.com) Copyright (C) 2001 ???? diff --git a/server/drivers/CFontz633.c b/server/drivers/CFontz633.c index b2e6390..8c4c977 100644 --- a/server/drivers/CFontz633.c +++ b/server/drivers/CFontz633.c @@ -1,3 +1,7 @@ +/** \file server/drivers/CFontz633.c + * LCDd \c CFontz633 driver for CFA633 devices by CrystalFontz, Inc. + */ + /* This is the LCDproc driver for CrystalFontz 633 devices (get yours from http://crystalfontz.com) diff --git a/server/drivers/CFontzPacket.c b/server/drivers/CFontzPacket.c index 8985156..f0fb116 100644 --- a/server/drivers/CFontzPacket.c +++ b/server/drivers/CFontzPacket.c @@ -1,3 +1,8 @@ +/** \file server/drivers/CFontzPacket.c + * LCDd \c CFontzPacket driver for the CFA631, CFA633 & CFA635 display series + * by CrystalFontz, Inc. + */ + /* * This is the LCDproc driver for CrystalFontz LCD using Packet protocol. * It support the CrystalFontz 633 USB/Serial, the 631 USB and the 635 USB diff --git a/server/drivers/EyeboxOne.c b/server/drivers/EyeboxOne.c index 3dcb6ed..1868fa9 100644 --- a/server/drivers/EyeboxOne.c +++ b/server/drivers/EyeboxOne.c @@ -1,3 +1,8 @@ +/** \file server/drivers/EyeboxOne.c + * LCDd \c EyeboxOne driver for the display used in the Eyebox ONE server + * by Rightvision. + */ + /* This is the LCDproc driver for EyeboxOne devices This code is based on MtxOrb driver (William Ferrell and Scott Scriven) diff --git a/server/drivers/MD8800.c b/server/drivers/MD8800.c index d06eaa6..bdd6fd6 100644 --- a/server/drivers/MD8800.c +++ b/server/drivers/MD8800.c @@ -1,5 +1,8 @@ -/* This is the LCDproc driver for the VFD of the Medion MD8800 PC +/** \file server/drivers/MD8800.c + * LCDd \c MD8800 driver for the CFD used in Medion MD8800 PCs. + */ +/* Copyright (C) 2006 Stefan Herdler in collaboration with Martin Møller. This source Code is based on the NoritakeVFD, the serialVFD and the diff --git a/server/drivers/MtxOrb.c b/server/drivers/MtxOrb.c index 0467c19..732d312 100644 --- a/server/drivers/MtxOrb.c +++ b/server/drivers/MtxOrb.c @@ -1,3 +1,7 @@ +/** \file server/drivers/MtxOrb.c + * LCDd \c MtxOrb driver for Matrix Orbital character mode displays. + */ + /* This is the LCDproc driver for Matrix Orbital devices (http://www.matrixorbital.com) diff --git a/server/drivers/NoritakeVFD.c b/server/drivers/NoritakeVFD.c index 6531e5b..e13e6fb 100644 --- a/server/drivers/NoritakeVFD.c +++ b/server/drivers/NoritakeVFD.c @@ -1,5 +1,8 @@ -/* This is the LCDproc driver for Noritake VFD Device CU20045SCPB-T28A +/** \file server/drivers/NoritakeVFD.c + * LCDd \c NoritakeVFD driver for the Noritake VFD Device CU20045SCPB-T28A. + */ +/* Copyright (C) 2005 Simon Funke Copyright (C) 2007 Richard Muratti ricacho@gmail.com Copyright (C) 2007 Peter Marschall diff --git a/server/drivers/adv_bignum.c b/server/drivers/adv_bignum.c index b7d248d..eb428ca 100644 --- a/server/drivers/adv_bignum.c +++ b/server/drivers/adv_bignum.c @@ -1,4 +1,9 @@ -/* This is the bignumber-library used by the serialVFD driver. +/** \file server/drivers/adv_bignum.c + * Library to generate big numbers on displays with different numbers + * custom characters. + */ + +/* This is the bignumber-library used by the serialVFD iand other drivers. Copyright (C) 2006 Stefan Herdler, 2006 Peter Marschall diff --git a/server/drivers/bayrad.c b/server/drivers/bayrad.c index 98b45b4..f6dd735 100644 --- a/server/drivers/bayrad.c +++ b/server/drivers/bayrad.c @@ -1,3 +1,7 @@ +/** \file server/drivers/bayrad.c + * LCDd \c bayrad driver for BayRAD LCD modules by EMAC, Inc. + */ + /* Code file for BayRAD driver * for LCDproc LCD software * by Nathan Yawn, yawn@emacinc.com diff --git a/server/drivers/ea65.c b/server/drivers/ea65.c index 878c1a9..10eb50c 100644 --- a/server/drivers/ea65.c +++ b/server/drivers/ea65.c @@ -1,3 +1,7 @@ +/** \file server/drivers/ea65.c + * LCDd \c ea65 driver for the VFD used in the Aopen XC Cube-AV EA65 media barebone. + */ + /* This is the LCDproc driver for the vfd on the Aopen EA65, based on the Crystal Fontz driver. diff --git a/server/drivers/g15.c b/server/drivers/g15.c index 84dc362..5232d6b 100644 --- a/server/drivers/g15.c +++ b/server/drivers/g15.c @@ -1,5 +1,8 @@ -/* This is the LCDproc driver for the LCD on the Logitech G15 keyboard +/** \file server/drivers/g15.c + * LCDd \c g15 driver for the LCD on the Logitech G15 keyboard. + */ +/* Copyright (C) 2006 Anthony J. Mirabella. 2006-07-23 Version 1.0: Most functions should be implemented and working diff --git a/server/drivers/glcdlib.c b/server/drivers/glcdlib.c index 8e8a2c6..c578820 100644 --- a/server/drivers/glcdlib.c +++ b/server/drivers/glcdlib.c @@ -1,3 +1,7 @@ +/** \file server/drivers/glcdlib.c + * LCDd \c glcdlib "meta-driver" for all displays supported by graphlcd-base. + */ + /* * This so-called "meta-driver" extends LCDproc's supported drivers by * all the drivers supported by graphlcd-base, which you can get from diff --git a/server/drivers/glk.c b/server/drivers/glk.c index 0472625..452f0c9 100644 --- a/server/drivers/glk.c +++ b/server/drivers/glk.c @@ -1,3 +1,7 @@ +/** \file server/drivers/glk.c + * LCDd \c glk driver for graphical displays by MatroxOrbital. + */ + /* * MatrixOrbital GLK Graphic Display Driver * diff --git a/server/drivers/hd44780.c b/server/drivers/hd44780.c index 777e7fc..ddc01ca 100644 --- a/server/drivers/hd44780.c +++ b/server/drivers/hd44780.c @@ -1,5 +1,5 @@ /** \file server/drivers/hd44780.c - * LCDd \c hd44780 base driver module for Hitachi HD44780 based LCD displays. + * LCDd \c hd44780 "meta-driver" for Hitachi HD44780 based LCD displays. * This is a modular driver that readily allows support for multiple HD44780 * connection types to be added in a flexible and maintainable manner. * diff --git a/server/drivers/i2500vfd.c b/server/drivers/i2500vfd.c index feab37d..8f2cdeb 100644 --- a/server/drivers/i2500vfd.c +++ b/server/drivers/i2500vfd.c @@ -1,3 +1,7 @@ +/** \file server/drivers/i2500vfd.c + * LCDd \c i2500vfd driver for Intra2net's Intranator 2500 VFD displays. + */ + ////////////////////////////////////////////////////////////////////////// // This is a driver for the Intra2net Intranator 2500 VFD display // // // diff --git a/server/drivers/icp_a106.c b/server/drivers/icp_a106.c index 665d9ea..8502ccf 100644 --- a/server/drivers/icp_a106.c +++ b/server/drivers/icp_a106.c @@ -1,4 +1,7 @@ -/*icp_a106.c*/ +/** \file server/drivers/icp_a106.c + * LCDd \c icp_a106 for the ICP A106 alarm/LCD board used in 19" rack cases by ICP. + */ + /* This is the LCDproc driver for the ICP A106 alarm/LCD board, used in 19" rack cases by ICP diff --git a/server/drivers/imon.c b/server/drivers/imon.c index cf8615e..893dbe1 100644 --- a/server/drivers/imon.c +++ b/server/drivers/imon.c @@ -1,4 +1,8 @@ -/** +/** \file server/drivers/imon.c + * LCDd \c imon driver for the Soundgraph iMON IR/VFD module. + */ + +/* * Driver for Soundgraph/Ahanix/Silverstone/Uneed/Accent iMON IR/VFD Module * * In order to be able to use it, you have to get and install one of diff --git a/server/drivers/irmanin.c b/server/drivers/irmanin.c index 2362932..012a0cd 100644 --- a/server/drivers/irmanin.c +++ b/server/drivers/irmanin.c @@ -1,3 +1,7 @@ +/** \file server/drivers/irmanin.c + * LCDd \c irman input driver fora the IrMan IR remote control. + */ + /* irmanin.c - test/demo of LIBIR's to interface with lcdproc (LCDd) */ /* Copyright (C) 1999 David Glaude loosely based on workmanir.c */ /* workmanir.c - test/demo of LIBIR's high level command functions */ diff --git a/server/drivers/irtrans.c b/server/drivers/irtrans.c index cbdd6b6..0c2a3f7 100644 --- a/server/drivers/irtrans.c +++ b/server/drivers/irtrans.c @@ -1,9 +1,10 @@ +/** \file server/drivers/irtrans.c + * LCDd \c irtrans driver for IRTrans VFD displays. + */ + /* * irtrans driver * - * Displays LCD screens, one after another; suitable for hard-copy - * terminals. - * * Copyright (C) 1998-2007 * * Copyright (C) 2007 Phant0m diff --git a/server/drivers/joy.c b/server/drivers/joy.c index 4d97f5e..ee1ddb6 100644 --- a/server/drivers/joy.c +++ b/server/drivers/joy.c @@ -1,3 +1,7 @@ +/** \file server/drivers/joy.c + * LCDd \c joy input driver for inputting data using joysticks. + */ + /* * Joystick input driver for LCDd * diff --git a/server/drivers/lb216.c b/server/drivers/lb216.c index f8ba259..7e84742 100644 --- a/server/drivers/lb216.c +++ b/server/drivers/lb216.c @@ -1,5 +1,8 @@ +/** \file server/drivers/lb216.c + * LCDd \c lb216 driver for the LB216 by R.T.N. Australia. + */ + /* - * * Chris Debenham - Sun Systems Engineer * * Heres a bit more info on the display. diff --git a/server/drivers/lcdm001.c b/server/drivers/lcdm001.c index 0383bc1..3661437 100644 --- a/server/drivers/lcdm001.c +++ b/server/drivers/lcdm001.c @@ -1,6 +1,8 @@ -/*lcdm001.c*/ -/* This is the LCDproc driver for the "LCDM001" device from kernelconcepts.de +/** \file server/drivers/lcdm001.c + * LCDd \c lcdm001 driver for the LCDM001 device from kernelconcepts.de. + */ +/* Copyright (C) 2001 Rene Wagner This program is free software; you can redistribute it and/or modify diff --git a/server/drivers/lcterm.c b/server/drivers/lcterm.c index efae8ce..0e868c6 100644 --- a/server/drivers/lcterm.c +++ b/server/drivers/lcterm.c @@ -1,8 +1,9 @@ -/*lcterm.c*/ -/* - This is the LCDproc driver for the "LCTerm" serial LCD terminal - from Helmut Neumark Elektronik, www.neumark.de +/** \file server/drivers/lcterm.c + * LCDd \c lcterm driver for the LCTerm serial LCD terminal from Helmut Neumark Elektronik, + * www.neumark.de. + */ +/* Copyright (C) 2002 Michael Schwingen This program is free software; you can redistribute it and/or modify diff --git a/server/drivers/lircin.c b/server/drivers/lircin.c index 7f544e8..f68f354 100644 --- a/server/drivers/lircin.c +++ b/server/drivers/lircin.c @@ -1,5 +1,8 @@ -/* This is the LCDproc driver for LIRC infrared devices (http://www.lirc.org) +/** \file server/drivers/lircin.c + * LCDd \c lirc input driver for LIRC infrared devices (http://www.lirc.org), + */ +/* Copyright (C) 2000, Harald Klein 2002, Rene Wagner [Merged some stuff from a different lircin driver, so:] diff --git a/server/drivers/lis.c b/server/drivers/lis.c index a058c63..b14eb9a 100644 --- a/server/drivers/lis.c +++ b/server/drivers/lis.c @@ -1,3 +1,7 @@ +/** \file server/drivers/lis.c + * LCDd \c lis driver for the L.I.S MCE VFD by vlsys.co.kr. + */ + /* * LIS driver for lcdproc * For the L.I.S MCE vacuum fluorescent display from vlsys.co.kr diff --git a/server/drivers/ms6931.c b/server/drivers/ms6931.c index 2ffb017..e792337 100644 --- a/server/drivers/ms6931.c +++ b/server/drivers/ms6931.c @@ -1,3 +1,7 @@ +/** \file server/drivers/ms6931.c + * LCDd \c ms6931 driver for MSI-6931 displays in 1U rack servers by MSI. + */ + /* This is the LCDproc driver for MSI-6931 displays as found in the following 1U rack servers by MSI: MS-9202 diff --git a/server/drivers/mtc_s16209x.c b/server/drivers/mtc_s16209x.c index 8677245..e1f1696 100644 --- a/server/drivers/mtc_s16209x.c +++ b/server/drivers/mtc_s16209x.c @@ -1,3 +1,7 @@ +/** \file server/drivers/mtc_s16209x.c + * LCDd \c mtc_s16209x driver for the MTC_S16209x LCD display by Microtips Technology Inc. + */ + /* * LCD Driver for MTC_S16209x LCD display, used with lcdproc (lcdproc.org) * Copyright (C) 2002 SecureCiRT, A SBU of Z-Vance Pte Ltd (Singapore) diff --git a/server/drivers/mx5000.c b/server/drivers/mx5000.c index 20f2260..c6041cb 100644 --- a/server/drivers/mx5000.c +++ b/server/drivers/mx5000.c @@ -1,5 +1,8 @@ -/* This is the LCDproc driver header for the Logitech MX5000 keyboard +/** \file server/drivers/mx5000.c + * LCDd \c mx5000 driver for the Logitech MX5000 keyboard. + */ +/* Author: Christian Jodar (tian@gcstar.org) Copyright (C) 2008 Christian Jodar diff --git a/server/drivers/picolcd.c b/server/drivers/picolcd.c index 71041ee..cba5fa2 100644 --- a/server/drivers/picolcd.c +++ b/server/drivers/picolcd.c @@ -1,6 +1,8 @@ +/** \file server/drivers/picolcd.c + * LCDd \c picolcd driver for the ini-Box.com USB LCD picoLCD displays. + */ + /* - * picoLCD driver for lcdPROC - * * (c) 2007 NitroSecurity, Inc. * Written by Gatewood Green or * (c) 2007-2008 Peter Marschall - adapted coding style and reporting to LCDproc diff --git a/server/drivers/pylcd.c b/server/drivers/pylcd.c index 22af2b6..cd2bbc5 100644 --- a/server/drivers/pylcd.c +++ b/server/drivers/pylcd.c @@ -1,7 +1,8 @@ -/* pylcd.c */ +/** \file server/drivers/pylcd.c + * LCDd \c pyramid driver for the programmable LC displays from Pyramid. + */ /* - This is the LCDproc driver for the "pyramid" LCD device from Pyramid. Copyright (C) 2005 Silvan Marco Fin Copyright (C) 2006 coresystems GmbH diff --git a/server/drivers/sed1330.c b/server/drivers/sed1330.c index 236a05c..7b4fa44 100644 --- a/server/drivers/sed1330.c +++ b/server/drivers/sed1330.c @@ -1,3 +1,7 @@ +/** \file server/drivers/sed1330.c + * LCDd \c sed1330 driver for SED1330/1335 graphical displays. + */ + /* * Driver for SED1330/1335 graphical displays * diff --git a/server/drivers/sed1520.c b/server/drivers/sed1520.c index 339fe88..cc14c8e 100644 --- a/server/drivers/sed1520.c +++ b/server/drivers/sed1520.c @@ -1,3 +1,7 @@ +/** \file server/drivers/sed1520.c + * LCDd \c sed1520 driver for graphic displays based on the SED1520. + */ + ////////////////////////////////////////////////////////////////////////// // This is a driver for 122x32 pixel graphic displays based on the // // SED1520 Controller connected to the parallel port. Check // diff --git a/server/drivers/serialPOS.c b/server/drivers/serialPOS.c index c22e4e8..555b4a4 100644 --- a/server/drivers/serialPOS.c +++ b/server/drivers/serialPOS.c @@ -1,3 +1,8 @@ +/** \file server/drivers/serialPOS.c + * LCDd \c serialPOS driver for Point Of Sale ("POS") devices using + * various protocols. + */ + /* This is the LCDproc driver for Point Of Sale ("POS") devices using various protocols. While it currently only supports AEDEX, it can be extended to provide support for many POS emulation types. diff --git a/server/drivers/serialVFD.c b/server/drivers/serialVFD.c index 4db881f..6345ed3 100644 --- a/server/drivers/serialVFD.c +++ b/server/drivers/serialVFD.c @@ -1,5 +1,8 @@ -/* This is the LCDproc driver for various serial VFD Devices +/** \file server/drivers/serialVFD.c + * LCDd \c serialVFD driver for various serial VFD dvices. + */ +/* Copyright (C) 2006 Stefan Herdler This driver is based on wirz-sli.c, hd44780.c, drv_base.c and NoritakeVFD diff --git a/server/drivers/shuttleVFD.c b/server/drivers/shuttleVFD.c index 59e9f75..384a77f 100644 --- a/server/drivers/shuttleVFD.c +++ b/server/drivers/shuttleVFD.c @@ -1,6 +1,8 @@ +/** \file server/drivers/shuttleVFD.c + * LCDd \c shuttleVFD driver for VFD displays found in various Shuttle XPC models. + */ + /* - * ShuttleVFD driver - * * Copyright (C) 2007 Thien Vu * * This program is free software; you can redistribute it and/or modify diff --git a/server/drivers/stv5730.c b/server/drivers/stv5730.c index f7a150c..bd1ab47 100644 --- a/server/drivers/stv5730.c +++ b/server/drivers/stv5730.c @@ -1,3 +1,8 @@ +/** \file server/drivers/stv5730.c + * LCDd \c stv5730 driver for the STV5730A on-screen display chip + * connected to a parallel port. + */ + ////////////////////////////////////////////////////////////////////////// // This is a driver for the STV5730A on-screen display chip in con- // // junction with a parallel port interface. Check // diff --git a/server/drivers/svgalib_drv.c b/server/drivers/svgalib_drv.c index f9e5e1c..8c818f4 100644 --- a/server/drivers/svgalib_drv.c +++ b/server/drivers/svgalib_drv.c @@ -1,3 +1,7 @@ +/** \file server/drivers/svgalib_drv.c + * LCDd \c svga driver for displaying on SVGA screens. + */ + /* This is a hack of the curses driver. It's my first attempt at SVGALIB programming so please send comments to . diff --git a/server/drivers/t6963.c b/server/drivers/t6963.c index b563a73..f68c9a3 100644 --- a/server/drivers/t6963.c +++ b/server/drivers/t6963.c @@ -1,3 +1,7 @@ +/** \file server/drivers/t6963.c + * LCDd \c t6963 driver for Toshiba T6963 based LCD displays. + */ + /* * Base driver module for Toshiba T6963 based LCD displays. ver 2.2 * diff --git a/server/drivers/tyan_lcdm.c b/server/drivers/tyan_lcdm.c index 9106725..1a5b1f3 100644 --- a/server/drivers/tyan_lcdm.c +++ b/server/drivers/tyan_lcdm.c @@ -1,5 +1,8 @@ -/* This is the LCDproc driver for tyan lcd module (tyan Barebone GS series) +/** \file server/drivers/tyan_lcdm.c + * LCDd \c tyan driver for the CLD module found in Tyan GS series barebones. + */ +/* Author: yhlu@tyan.com Copyright (C) 2004 Tyan Corp diff --git a/server/drivers/ula200.c b/server/drivers/ula200.c index 53b95f3..4d16f9b 100644 --- a/server/drivers/ula200.c +++ b/server/drivers/ula200.c @@ -1,3 +1,7 @@ +/** \file server/drivers/ula200.c + * LCDd \c ula200 driver for the ULA-200 from ELV (http://www.elv.de). + */ + // Description: // // This is a driver for the ULA-200 from ELV (http://www.elv.de). It's a small diff --git a/server/drivers/wirz-sli.c b/server/drivers/wirz-sli.c index 55bf09b..9def680 100644 --- a/server/drivers/wirz-sli.c +++ b/server/drivers/wirz-sli.c @@ -1,3 +1,7 @@ +/** \file server/drivers/wirz-sli.c + * LCDd \c sli driver for the SLI devices by Wirz, http://www.wirz.com/. + */ + /* wirz-sli.c -- Source file for LCDproc Wirz SLI driver Copyright (C) 1999 Horizon Technologies-http://horizon.pair.com/ Written by Bryan Rittmeyer - Released under GPL diff --git a/server/drivers/xosdlib_drv.c b/server/drivers/xosdlib_drv.c index 10a13e1..b1066ac 100644 --- a/server/drivers/xosdlib_drv.c +++ b/server/drivers/xosdlib_drv.c @@ -2,8 +2,7 @@ * LCDd \c xosd driver for on screen display on X windows. */ -/* This is the LCDproc driver for xosdlib - +/* Copyright(C) 2005 Peter Marschall based on GPL'ed code: