From 6a6b44778c7c70a1e8e97e12f8927059edb170de Mon Sep 17 00:00:00 2001 From: marschap Date: Thu, 4 Oct 2007 16:30:19 +0000 Subject: [PATCH] doxygenate a little more --- clients/lcdexec/menu.h | 18 +++++++++--------- server/drivers/hd44780-4bit.c | 11 ++++++----- server/drivers/hd44780-bwct-usb.c | 10 ++++++---- server/drivers/hd44780-charmap.h | 7 +++++-- server/drivers/hd44780-drivers.h | 10 +++++----- server/drivers/hd44780-ext8bit.c | 11 ++++++----- server/drivers/hd44780-i2c.c | 12 +++++++----- server/drivers/hd44780-lcd2usb.c | 10 ++++++---- server/drivers/hd44780-lis2.c | 12 +++++------- server/drivers/hd44780-low.h | 6 ++++-- server/drivers/hd44780-serial.c | 9 ++++++--- server/drivers/hd44780-serialLpt.c | 11 ++++++----- server/drivers/hd44780-winamp.c | 10 ++++++---- server/drivers/hd44780.c | 15 ++++++++------- server/drivers/hd44780.h | 15 ++++++++------- 15 files changed, 93 insertions(+), 74 deletions(-) diff --git a/clients/lcdexec/menu.h b/clients/lcdexec/menu.h index c7a4d07..c5795d2 100644 --- a/clients/lcdexec/menu.h +++ b/clients/lcdexec/menu.h @@ -22,26 +22,26 @@ # define FALSE 0 #endif - +/** Symbolic names for the types of a MenuEntry */ typedef enum { - unknown = 0, /**< unknown menu entry. */ - menu = 1, /**< menu entry representing a menu. */ - exec = 2, /**< menu entry repesenting a command. */ + unknown = 0, /**< Unknown MenuEntry type. */ + menu = 1, /**< MenuEntry representing a menu. */ + exec = 2, /**< MenuEntry representing an executable command. */ } MenuType; typedef struct menu_entry { - char *name; /**< Name of the menu entry. */ - char *displayname; /**< Display name of the enty. */ + char *name; /**< Name of the menu entry (from section name). */ + char *displayname; /**< isible name of the entry. */ int id; /**< Internal ID of the entry. */ MenuType type; /**< Type of the entry. */ // variables necessary for type menu - struct menu_entry *entries; /**< Subordinate menu entries (for MenuType menu). */ - struct menu_entry *next; /**< Next sibling menu entry (for MenuType menu). */ + struct menu_entry *entries; /**< Subordinate menu entries (for MenuType \c menu). */ + struct menu_entry *next; /**< Next sibling menu entry (for MenuType \c menu). */ // variables necessary for type exec - char *command; /**< Command to execute (for MenuType exec). */ + char *command; /**< Command to execute (for MenuType \c exec). */ } MenuEntry; diff --git a/server/drivers/hd44780-4bit.c b/server/drivers/hd44780-4bit.c index 2be29cd..f926750 100644 --- a/server/drivers/hd44780-4bit.c +++ b/server/drivers/hd44780-4bit.c @@ -1,9 +1,10 @@ -/* - * 4-bit driver module for Hitachi HD44780 based LCD displays. - * The LCD is operated in it's 4 bit-mode to be connected to a single - * 8 bit-port. +/** \file hd44780-4bit.c + * \c 4bit connection type of \c hd44780 driver for Hitachi HD44780 based LCD displays. * - * Copyright (c) 2000, 1999, 1995 Benjamin Tse + * The LCD is operated in its 4 bit-mode to be connected to a single PC parallel port. + */ + +/* Copyright (c) 2000, 1999, 1995 Benjamin Tse * 2001 Joris Robijn * 1999 Andrew McMeikan * 1998 Richard Rognlie diff --git a/server/drivers/hd44780-bwct-usb.c b/server/drivers/hd44780-bwct-usb.c index 96612d8..eb049b6 100644 --- a/server/drivers/hd44780-bwct-usb.c +++ b/server/drivers/hd44780-bwct-usb.c @@ -1,8 +1,10 @@ -/* - * USB driver module for Hitachi HD44780 based LCD displays. - * http://www.bwct.de/lcd.html +/** \file hd44780-bwct-usb.c + * \c bwctusb connection type of \c hd44780 driver for Hitachi HD44780 based LCD displays. * - * Copyright (c) 2004, Bernd Walter + * See http://www.bwct.de/lcd.html + */ + +/* Copyright (c) 2004, Bernd Walter * Contributions: * Copyright (c) 2004, Peter Marschall * diff --git a/server/drivers/hd44780-charmap.h b/server/drivers/hd44780-charmap.h index c75eb49..1ecc680 100644 --- a/server/drivers/hd44780-charmap.h +++ b/server/drivers/hd44780-charmap.h @@ -1,5 +1,8 @@ -/* - * Character mapping for HD44780 devices by Mark Haemmerling . +/** \file hd44780-charmap.h + * Character mapping for HD44780 devices. + */ + +/* Character mapping for HD44780 devices by Mark Haemmerling . * * Translates ISO 8859-1 to any HD44780 charset. * diff --git a/server/drivers/hd44780-drivers.h b/server/drivers/hd44780-drivers.h index 0abeafd..acdc5e5 100644 --- a/server/drivers/hd44780-drivers.h +++ b/server/drivers/hd44780-drivers.h @@ -1,10 +1,10 @@ -/* - * Low-level driver types, headers and names. +/** \file hd44780-drivers.h + * Interface to low-level driver types, headers and names. * * To add support for a new driver in this file: - * 1. include your header file - * 2. Add a new connectionType - * 3. Add an entry in the connectionMapping structure + * \li 1. include your header file + * \li 2. Add a new connectionType + * \li 3. Add an entry in the \c ConnectionMapping structure */ #ifndef HD44780_DRIVERS_H diff --git a/server/drivers/hd44780-ext8bit.c b/server/drivers/hd44780-ext8bit.c index f301b6e..740a1fd 100644 --- a/server/drivers/hd44780-ext8bit.c +++ b/server/drivers/hd44780-ext8bit.c @@ -1,9 +1,10 @@ -/* - * 8-bit driver module for Hitachi HD44780 based LCD displays. - * The LCD is operated in it's 8 bit-mode to be connected to a single - * PC parallel port. +/** \file hd44780-ext8bit.c + * \c 8bit connection type of \c hd44780 driver for Hitachi HD44780 based LCD displays. * - * Copyright (c) 1999, 1995 Benjamin Tse + * The LCD is operated in its 8 bit-mode to be connected to a single PC parallel port. + */ + +/* Copyright (c) 1999, 1995 Benjamin Tse * 2001 Joris Robijn * * The connections are: diff --git a/server/drivers/hd44780-i2c.c b/server/drivers/hd44780-i2c.c index 50d48e4..171b4c3 100644 --- a/server/drivers/hd44780-i2c.c +++ b/server/drivers/hd44780-i2c.c @@ -1,9 +1,11 @@ -/* - * i2c driver module for Hitachi HD44780 based LCD displays. - * The LCD is operated in it's 4 bit-mode to be connected to the 8 bit-port - * of a single PCF8574(A) or PCA9554(A) that is accessed by the server via the i2c bus. +/** \file hd44780-i2c.c + * \c i2c connection type of \c hd44780 driver for Hitachi HD44780 based LCD displays. * - * Copyright (c) 2005 Matthias Goebl + * The LCD is operated in its 4 bit-mode to be connected to the 8 bit-port + * of a single PCF8574(A) or PCA9554(A) that is accessed by the server via the i2c bus. + */ + +/* Copyright (c) 2005 Matthias Goebl * 2000, 1999, 1995 Benjamin Tse * 2001 Joris Robijn * 1999 Andrew McMeikan diff --git a/server/drivers/hd44780-lcd2usb.c b/server/drivers/hd44780-lcd2usb.c index 3214983..55bc08c 100644 --- a/server/drivers/hd44780-lcd2usb.c +++ b/server/drivers/hd44780-lcd2usb.c @@ -1,8 +1,10 @@ -/* driver module for Hitachi HD44780 based LCD displays - * connected to using the lcd2usb interface - * (http://www.harbaum.org/till/lcd2usb) +/** \file hd44780-lcd2usb.c + * \c lcd2usb connection type of \c hd44780 driver for Hitachi HD44780 based LCD displays. * - * Copyright (C) 2007 Peter Marschall + * See http://www.harbaum.org/till/lcd2usb. + */ + +/* Copyright (C) 2007 Peter Marschall * * This file is released under the GNU General Public License. Refer to the * COPYING file distributed with this package. diff --git a/server/drivers/hd44780-lis2.c b/server/drivers/hd44780-lis2.c index 99685d6..e3318f7 100644 --- a/server/drivers/hd44780-lis2.c +++ b/server/drivers/hd44780-lis2.c @@ -1,6 +1,8 @@ -/* - * LIS2 Serializer driver - * Modification of the code of the LCDSerializer driver +/** \file hd44780-lis2.c + * \c lis2 connection type of \c hd44780 driver for Hitachi HD44780 based LCD displays. + */ + +/* Modification of the code of the LCDSerializer driver * * Copyright (c) 1997, Matthias Prinke * 1998, Richard Rognlie @@ -13,10 +15,6 @@ * * This file is released under the GNU General Public License. Refer to the * COPYING file distributed with this package. - * - * - * - * */ #include "hd44780-lis2.h" diff --git a/server/drivers/hd44780-low.h b/server/drivers/hd44780-low.h index 0c93218..0b9b745 100644 --- a/server/drivers/hd44780-low.h +++ b/server/drivers/hd44780-low.h @@ -1,5 +1,7 @@ -// This header contains low level code to export from hd44780.c to "lower" HW -// implementation dependent files. +/** \file hd44780-low.h + * Interface to low level code to export from hd44780.c to "lower" HW + * implementation dependent files. + */ #ifndef HD_LOW_H #define HD_LOW_H diff --git a/server/drivers/hd44780-serial.c b/server/drivers/hd44780-serial.c index 60697bd..95cc9eb 100644 --- a/server/drivers/hd44780-serial.c +++ b/server/drivers/hd44780-serial.c @@ -1,6 +1,9 @@ -/* - * Driver for serial connected hd44780 LCDs - * Copyright (C) 2006-2007 Matteo Pillon +/** \file hd44780-serial.c + * Connection types \c picanlcd, \c lcdserializer, \c los-panel, \c vdr-lcd, + * \c vdr-wakeup, \c pertelian, ... of \c hd44780 driver for Hitachi HD44780 based LCD displays. + */ + +/* Copyright (C) 2006-2007 Matteo Pillon * * Some parts are based on the original pic-an-lcd driver code * Copyright (C) 1997, Matthias Prinke diff --git a/server/drivers/hd44780-serialLpt.c b/server/drivers/hd44780-serialLpt.c index 49bab26..fbe9234 100644 --- a/server/drivers/hd44780-serialLpt.c +++ b/server/drivers/hd44780-serialLpt.c @@ -1,9 +1,10 @@ -/* - * Serial LPT driver module for Hitachi HD44780 based LCD displays by - * Andrew McMeikan. The LCD is operated in it's 4 bit-mode through a - * 4094 shift register and supports a keypad. +/** \file hd44780-serialLPT.c + * \c serialLPT connection type of \c hd44780 driver for Hitachi HD44780 based LCD displays. * - * Copyright (c) 1999 Andrew McMeikan + * The LCD is operated in it's 4 bit-mode through a 4094 shift register and supports a keypad. + */ + +/* Copyright (c) 1999 Andrew McMeikan * modular driver 1999 Benjamin Tse * * 2001 Joris Robijn diff --git a/server/drivers/hd44780-winamp.c b/server/drivers/hd44780-winamp.c index 0799f4e..fe3b30b 100644 --- a/server/drivers/hd44780-winamp.c +++ b/server/drivers/hd44780-winamp.c @@ -1,8 +1,10 @@ -/* - * "Winamp" 8-bit driver module for Hitachi HD44780 based LCD displays. - * The LCD is operated in it's 8 bit-mode to be connected to a single - * PC parallel port. +/** \file hd44780-winamp.c + * \c winamp connection type of \c hd44780 driver for Hitachi HD44780 based LCD displays. * + * The LCD is operated in it's 8 bit-mode to be connected to a single PC parallel port. + */ + +/* * Copyright (c) 1999 Andrew McMeikan * modular driver 1999-2000 Benjamin Tse * diff --git a/server/drivers/hd44780.c b/server/drivers/hd44780.c index 4b19a45..f717ada 100644 --- a/server/drivers/hd44780.c +++ b/server/drivers/hd44780.c @@ -1,4 +1,4 @@ -/* +/** \file hd44780.c * Base driver module for Hitachi HD44780 based LCD displays. This is * a modular driver that readily allows support for alternative HD44780 * designs to be added in a flexible and maintainable manner. @@ -8,12 +8,13 @@ * to form a 16x8 display. * * To add support for additional HD44780 connections: - * 1. Add a connection type and mapping to hd44780-drivers.h - * 2. Call your initialisation roUine - * 3. Create the low-level driver (use hd44780-ext8bit.c as a starting point) - * 4. Modify the makefile - * - * Modular driver created and generic support for multiple displays added + * \li Add a connection type and mapping to hd44780-drivers.h + * \li Call your initialization routine + * \li Create the low-level driver (use hd44780-ext8bit.c as a starting point) + * \li Modify the makefile + */ + +/* Modular driver created and generic support for multiple displays added * Dec 1999, Benjamin Tse * * Modified July 2000 by Charles Steinkuehler to use one of 3 methods for delay diff --git a/server/drivers/hd44780.h b/server/drivers/hd44780.h index 6b32ccb..8ec655c 100644 --- a/server/drivers/hd44780.h +++ b/server/drivers/hd44780.h @@ -1,16 +1,17 @@ -/* - * Base driver module for Hitachi HD44780 based LCD displays. This is - * a modular driver that allows support for alternative HD44780 - * designs to be added in a flexible and maintainable manner. +/** \file hd44780.h + * Interface to the base driver module for Hitachi HD44780 based LCD displays. * - * This file is released under the GNU General Public License. Refer to the + * This is a modular driver that allows support for alternative HD44780 + * designs to be added in a flexible and maintainable manner. + */ + +/* This file is released under the GNU General Public License. Refer to the * COPYING file distributed with this package. * * Copyright (c) 1999, 1995 Benjamin Tse * 1999 Andrew McMeikan * 1998 Richard Rognlie - * - 1997 Matthias Prinke + * 1997 Matthias Prinke */ #ifndef HD44780_H