mangavalk/lcdproc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doxygenate a little more

Browse Source
This commit is contained in:
marschap
2007-10-04 16:30:19 +00:00
parent e00911e3ba
commit 6a6b44778c
15 changed files with 93 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files
clients/lcdexec/menu.h
+9 -9
View File
@@ -22,26 +22,26 @@
# define FALSE 0 # define FALSE 0
#endif #endif
/** Symbolic names for the types of a MenuEntry */
typedef enum { typedef enum {
unknown = 0, /**< unknown menu entry. */ unknown = 0, /**< Unknown MenuEntry type. */
menu = 1, /**< menu entry representing a menu. */ menu = 1, /**< MenuEntry representing a menu. */
exec = 2, /**< menu entry repesenting a command. */ exec = 2, /**< MenuEntry representing an executable command. */
} MenuType; } MenuType;
typedef struct menu_entry { typedef struct menu_entry {
char *name; /**< Name of the menu entry. */ char *name; /**< Name of the menu entry (from section name). */
char *displayname; /**< Display name of the enty. */ char *displayname; /**< isible name of the entry. */
int id; /**< Internal ID of the entry. */ int id; /**< Internal ID of the entry. */
MenuType type; /**< Type of the entry. */ MenuType type; /**< Type of the entry. */
// variables necessary for type menu // variables necessary for type menu
struct menu_entry *entries; /**< Subordinate menu entries (for MenuType menu). */ struct menu_entry *entries; /**< Subordinate menu entries (for MenuType \c menu). */
struct menu_entry *next; /**< Next sibling menu entry (for MenuType menu). */ struct menu_entry *next; /**< Next sibling menu entry (for MenuType \c menu). */
// variables necessary for type exec // variables necessary for type exec
char *command; /**< Command to execute (for MenuType exec). */ char *command; /**< Command to execute (for MenuType \c exec). */
} MenuEntry; } MenuEntry;
server/drivers/hd44780-4bit.c
+6 -5
View File
@@ -1,9 +1,10 @@
/* /** \file hd44780-4bit.c
* 4-bit driver module for Hitachi HD44780 based LCD displays. * \c 4bit connection type of \c hd44780 driver 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.
* *
* Copyright (c) 2000, 1999, 1995 Benjamin Tse <blt@Comports.com> * 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 <blt@Comports.com>
* 2001 Joris Robijn <joris@robijn.net> * 2001 Joris Robijn <joris@robijn.net>
* 1999 Andrew McMeikan <andrewm@engineer.com> * 1999 Andrew McMeikan <andrewm@engineer.com>
* 1998 Richard Rognlie <rrognlie@gamerz.net> * 1998 Richard Rognlie <rrognlie@gamerz.net>
server/drivers/hd44780-bwct-usb.c
+6 -4
View File
@@ -1,8 +1,10 @@
/* /** \file hd44780-bwct-usb.c
* USB driver module for Hitachi HD44780 based LCD displays. * \c bwctusb connection type of \c hd44780 driver for Hitachi HD44780 based LCD displays.
* http://www.bwct.de/lcd.html
* *
* Copyright (c) 2004, Bernd Walter <bernd@bwct.de> * See http://www.bwct.de/lcd.html
*/
/* Copyright (c) 2004, Bernd Walter <bernd@bwct.de>
* Contributions: * Contributions:
* Copyright (c) 2004, Peter Marschall <peter@adpm.de> * Copyright (c) 2004, Peter Marschall <peter@adpm.de>
* *
server/drivers/hd44780-charmap.h
+5 -2
View File
@@ -1,5 +1,8 @@
/* /** \file hd44780-charmap.h
* Character mapping for HD44780 devices by Mark Haemmerling <mail@markh.de>. * Character mapping for HD44780 devices.
*/
/* Character mapping for HD44780 devices by Mark Haemmerling <mail@markh.de>.
* *
* Translates ISO 8859-1 to any HD44780 charset. * Translates ISO 8859-1 to any HD44780 charset.
* *
server/drivers/hd44780-drivers.h
+5 -5
View File
@@ -1,10 +1,10 @@
/* /** \file hd44780-drivers.h
* Low-level driver types, headers and names. * Interface to low-level driver types, headers and names.
* *
* To add support for a new driver in this file: * To add support for a new driver in this file:
* 1. include your header file * \li 1. include your header file
* 2. Add a new connectionType * \li 2. Add a new connectionType
* 3. Add an entry in the connectionMapping structure * \li 3. Add an entry in the \c ConnectionMapping structure
*/ */
#ifndef HD44780_DRIVERS_H #ifndef HD44780_DRIVERS_H
server/drivers/hd44780-ext8bit.c
+6 -5
View File
@@ -1,9 +1,10 @@
/* /** \file hd44780-ext8bit.c
* 8-bit driver module for Hitachi HD44780 based LCD displays. * \c 8bit 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, 1995 Benjamin Tse <blt@Comports.com> * The LCD is operated in its 8 bit-mode to be connected to a single PC parallel port.
*/
/* Copyright (c) 1999, 1995 Benjamin Tse <blt@Comports.com>
* 2001 Joris Robijn <joris@robijn.net> * 2001 Joris Robijn <joris@robijn.net>
* *
* The connections are: * The connections are:
server/drivers/hd44780-i2c.c
+7 -5
View File
@@ -1,9 +1,11 @@
/* /** \file hd44780-i2c.c
* i2c driver module for Hitachi HD44780 based LCD displays. * \c i2c connection type of \c hd44780 driver 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.
* *
* Copyright (c) 2005 Matthias Goebl <matthias.goebl@goebl.net> * 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 <matthias.goebl@goebl.net>
* 2000, 1999, 1995 Benjamin Tse <blt@Comports.com> * 2000, 1999, 1995 Benjamin Tse <blt@Comports.com>
* 2001 Joris Robijn <joris@robijn.net> * 2001 Joris Robijn <joris@robijn.net>
* 1999 Andrew McMeikan <andrewm@engineer.com> * 1999 Andrew McMeikan <andrewm@engineer.com>
server/drivers/hd44780-lcd2usb.c
+6 -4
View File
@@ -1,8 +1,10 @@
/* driver module for Hitachi HD44780 based LCD displays /** \file hd44780-lcd2usb.c
* connected to using the lcd2usb interface * \c lcd2usb connection type of \c hd44780 driver for Hitachi HD44780 based LCD displays.
* (http://www.harbaum.org/till/lcd2usb)
* *
* Copyright (C) 2007 Peter Marschall <peter@adpm.de> * See http://www.harbaum.org/till/lcd2usb.
*/
/* Copyright (C) 2007 Peter Marschall <peter@adpm.de>
* *
* This file is released under the GNU General Public License. Refer to the * This file is released under the GNU General Public License. Refer to the
* COPYING file distributed with this package. * COPYING file distributed with this package.
server/drivers/hd44780-lis2.c
+5 -7
View File
@@ -1,6 +1,8 @@
/* /** \file hd44780-lis2.c
* LIS2 Serializer driver * \c lis2 connection type of \c hd44780 driver for Hitachi HD44780 based LCD displays.
* Modification of the code of the LCDSerializer driver */
/* Modification of the code of the LCDSerializer driver
* *
* Copyright (c) 1997, Matthias Prinke <m.prinke@trashcan.mcnet.de> * Copyright (c) 1997, Matthias Prinke <m.prinke@trashcan.mcnet.de>
* 1998, Richard Rognlie <rrognlie@gamerz.net> * 1998, Richard Rognlie <rrognlie@gamerz.net>
@@ -13,10 +15,6 @@
* *
* This file is released under the GNU General Public License. Refer to the * This file is released under the GNU General Public License. Refer to the
* COPYING file distributed with this package. * COPYING file distributed with this package.
*
*
*
*
*/ */
#include "hd44780-lis2.h" #include "hd44780-lis2.h"
server/drivers/hd44780-low.h
+4 -2
View File
@@ -1,5 +1,7 @@
// This header contains low level code to export from hd44780.c to "lower" HW /** \file hd44780-low.h
// implementation dependent files. * Interface to low level code to export from hd44780.c to "lower" HW
* implementation dependent files.
*/
#ifndef HD_LOW_H #ifndef HD_LOW_H
#define HD_LOW_H #define HD_LOW_H
server/drivers/hd44780-serial.c
+6 -3
View File
@@ -1,6 +1,9 @@
/* /** \file hd44780-serial.c
* Driver for serial connected hd44780 LCDs * Connection types \c picanlcd, \c lcdserializer, \c los-panel, \c vdr-lcd,
* Copyright (C) 2006-2007 Matteo Pillon <matteo.pillon@gmail.com> * \c vdr-wakeup, \c pertelian, ... of \c hd44780 driver for Hitachi HD44780 based LCD displays.
*/
/* Copyright (C) 2006-2007 Matteo Pillon <matteo.pillon@gmail.com>
* *
* Some parts are based on the original pic-an-lcd driver code * Some parts are based on the original pic-an-lcd driver code
* Copyright (C) 1997, Matthias Prinke <m.prinke@trashcan.mcnet.de> * Copyright (C) 1997, Matthias Prinke <m.prinke@trashcan.mcnet.de>
server/drivers/hd44780-serialLpt.c
+6 -5
View File
@@ -1,9 +1,10 @@
/* /** \file hd44780-serialLPT.c
* Serial LPT driver module for Hitachi HD44780 based LCD displays by * \c serialLPT connection type of \c hd44780 driver for Hitachi HD44780 based LCD displays.
* 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 <andrewm@engineer.com> * The LCD is operated in it's 4 bit-mode through a 4094 shift register and supports a keypad.
*/
/* Copyright (c) 1999 Andrew McMeikan <andrewm@engineer.com>
* modular driver 1999 Benjamin Tse <blt@Comports.com> * modular driver 1999 Benjamin Tse <blt@Comports.com>
* *
* 2001 Joris Robijn <joris@robijn.net> * 2001 Joris Robijn <joris@robijn.net>
server/drivers/hd44780-winamp.c
+6 -4
View File
@@ -1,8 +1,10 @@
/* /** \file hd44780-winamp.c
* "Winamp" 8-bit driver module for Hitachi HD44780 based LCD displays. * \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.
* *
* The LCD is operated in it's 8 bit-mode to be connected to a single PC parallel port.
*/
/*
* Copyright (c) 1999 Andrew McMeikan <andrewm@engineer.com> * Copyright (c) 1999 Andrew McMeikan <andrewm@engineer.com>
* modular driver 1999-2000 Benjamin Tse <blt@Comports.com> * modular driver 1999-2000 Benjamin Tse <blt@Comports.com>
* *
server/drivers/hd44780.c
+8 -7
View File
@@ -1,4 +1,4 @@
/* /** \file hd44780.c
* Base driver module for Hitachi HD44780 based LCD displays. This is * Base driver module for Hitachi HD44780 based LCD displays. This is
* a modular driver that readily allows support for alternative HD44780 * a modular driver that readily allows support for alternative HD44780
* designs to be added in a flexible and maintainable manner. * designs to be added in a flexible and maintainable manner.
@@ -8,12 +8,13 @@
* to form a 16x8 display. * to form a 16x8 display.
* *
* To add support for additional HD44780 connections: * To add support for additional HD44780 connections:
* 1. Add a connection type and mapping to hd44780-drivers.h * \li Add a connection type and mapping to hd44780-drivers.h
* 2. Call your initialisation roUine * \li Call your initialization routine
* 3. Create the low-level driver (use hd44780-ext8bit.c as a starting point) * \li Create the low-level driver (use hd44780-ext8bit.c as a starting point)
* 4. Modify the makefile * \li Modify the makefile
* */
* Modular driver created and generic support for multiple displays added
/* Modular driver created and generic support for multiple displays added
* Dec 1999, Benjamin Tse <blt@Comports.com> * Dec 1999, Benjamin Tse <blt@Comports.com>
* *
* Modified July 2000 by Charles Steinkuehler to use one of 3 methods for delay * Modified July 2000 by Charles Steinkuehler to use one of 3 methods for delay
server/drivers/hd44780.h
+8 -7
View File
@@ -1,16 +1,17 @@
/* /** \file hd44780.h
* Base driver module for Hitachi HD44780 based LCD displays. This is * Interface to the base driver module for Hitachi HD44780 based LCD displays.
* 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 * 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. * COPYING file distributed with this package.
* *
* Copyright (c) 1999, 1995 Benjamin Tse <blt@Comports.com> * Copyright (c) 1999, 1995 Benjamin Tse <blt@Comports.com>
* 1999 Andrew McMeikan <andrewm@engineer.com> * 1999 Andrew McMeikan <andrewm@engineer.com>
* 1998 Richard Rognlie <rrognlie@gamerz.net> * 1998 Richard Rognlie <rrognlie@gamerz.net>
* * 1997 Matthias Prinke <m.prinke@trashcan.mcnet.de>
1997 Matthias Prinke <m.prinke@trashcan.mcnet.de>
*/ */
#ifndef HD44780_H #ifndef HD44780_H