diff --git a/server/client.c b/server/client.c index 8886938..28ded60 100644 --- a/server/client.c +++ b/server/client.c @@ -1,15 +1,14 @@ -/** \file client.c +/** \file server/client.c * Define all the client data and actions. */ /* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2002, Joris Robijn - * */ #include diff --git a/server/client.h b/server/client.h index cc55a83..ba252f9 100644 --- a/server/client.h +++ b/server/client.h @@ -1,15 +1,14 @@ -/** \file client.h +/** \file server/client.h * Defines all the client data and actions. */ /* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2002, Joris Robijn - * */ #include "menu.h" diff --git a/server/clients.c b/server/clients.c index 1f11fd5..49ed48d 100644 --- a/server/clients.c +++ b/server/clients.c @@ -1,18 +1,15 @@ -/* - * clients.c - * This file is part of LCDd, the lcdproc server. +/** \file server/clients.c + * Manage the list of clients that are connected. + * Init/shut down client system, and search for clients in the list. + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2002, Joris Robijn - * - * - * Inits/shuts down client system, - * and searches for clients in the list. - * On short: manages the list of clients that are connected. - * */ #include diff --git a/server/clients.h b/server/clients.h index 338b486..3f420a8 100644 --- a/server/clients.h +++ b/server/clients.h @@ -1,14 +1,13 @@ -/** \file clients.h +/** \file server/clients.h * Manage the list of clients that are connected. */ /* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven - * */ #ifndef CLIENTS_H diff --git a/server/driver.c b/server/driver.c index 1b5c965..d9c4e8d 100644 --- a/server/driver.c +++ b/server/driver.c @@ -1,15 +1,13 @@ -/* - * driver.c - * This file is part of LCDd, the lcdproc server. +/** \file server/driver.c + * This code does all actions on the driver object. + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 2001, Joris Robijn - * - * - * This code does all actions on the driver object. - * */ #include diff --git a/server/driver.h b/server/driver.h index 900b4cf..c07ada2 100644 --- a/server/driver.h +++ b/server/driver.h @@ -1,12 +1,12 @@ -/* - * driver.h - * This file is part of LCDd, the lcdproc server. +/** \file server/driver.h + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 2001, Joris Robijn - * */ #ifndef DRIVER_H diff --git a/server/drivers.c b/server/drivers.c index 363d7f1..c4de337 100644 --- a/server/drivers.c +++ b/server/drivers.c @@ -1,16 +1,13 @@ -/** \file drivers.c +/** \file server/drivers.c * Manage the lists of loaded drivers and perform actions on all drivers. */ /* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright(c) 2001, Joris Robijn - * - * - * */ #include diff --git a/server/drivers.h b/server/drivers.h index 9685e6e..a1e047b 100644 --- a/server/drivers.h +++ b/server/drivers.h @@ -1,12 +1,12 @@ -/* - * drivers.h - * This file is part of LCDd, the lcdproc server. +/** \file server/drivers.h + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 2001, Joris Robijn - * */ #ifndef DRIVERS_H diff --git a/server/input.c b/server/input.c index bd8a8a8..ccd63ba 100644 --- a/server/input.c +++ b/server/input.c @@ -1,15 +1,14 @@ -/* - * input.c - * This file is part of LCDd, the lcdproc server. +/** \file server/input.c + * Handles keypad (and other?) input from the user. + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2003, Joris Robijn - * - * - * Handles keypad (and other?) input from the user. */ diff --git a/server/input.h b/server/input.h index c42f85b..ff5bcef 100644 --- a/server/input.h +++ b/server/input.h @@ -1,13 +1,13 @@ -/* - * input.h - * This file is part of LCDd, the lcdproc server. +/** \file server/input.h + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2003, Joris Robijn - * */ #ifndef INPUT_H diff --git a/server/main.c b/server/main.c index 29374b5..792c8ac 100644 --- a/server/main.c +++ b/server/main.c @@ -1,18 +1,4 @@ -/* - * main.c - * This file is part of LCDd, the lcdproc server. - * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. - * - * Copyright (c) 1999, William Ferrell, Scott Scriven - * 2001, Joris Robijn - * 2001, Rene Wagner - * 2002, Mike Patnode - * 2002, Guillaume Filion - * 2003, Benjamin Tse (Win32 support) - * 2005-2006, Peter Marschall (cleanup) - * +/** \file server/main.c * Contains main(), plus signal callback functions and a help screen. * * Program init, command-line handling, and the main loop are @@ -22,7 +8,20 @@ * Some of this stuff should probably be move elsewhere eventually, * such as command-line handling and the main loop. main() is supposed * to be "dumb". + */ + +/* This file is part of LCDd, the lcdproc server. * + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. + * + * Copyright (c) 1999, William Ferrell, Scott Scriven + * 2001, Joris Robijn + * 2001, Rene Wagner + * 2002, Mike Patnode + * 2002, Guillaume Filion + * 2003, Benjamin Tse (Win32 support) + * 2005-2006, Peter Marschall (cleanup) */ #ifdef HAVE_CONFIG_H diff --git a/server/main.h b/server/main.h index 906b21f..810b8cc 100644 --- a/server/main.h +++ b/server/main.h @@ -1,13 +1,13 @@ -/* - * main.h - * This file is part of LCDd, the lcdproc server. +/** \file server/main.h + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2001, Joris Robijn - * */ #ifndef MAIN_H diff --git a/server/menu.c b/server/menu.c index 38ca572..c661c44 100644 --- a/server/menu.c +++ b/server/menu.c @@ -1,15 +1,4 @@ -/* - * menu.c - * This file is part of LCDd, the lcdproc server. - * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. - * - * Copyright (c) 1999, William Ferrell, Scott Scriven - * 2002, Joris Robijn - * 2004, F5 Networks, Inc. - IP-address input - * 2005, Peter Marschall - error checks, ... - * +/** \file server/menu.c * Handles a menu and all actions that can be performed on it. Note that a * menu is itself also a menuitem. * @@ -20,7 +9,17 @@ * The servermenu is created from servermenu.c * * For separation this file should never need to include menuscreen.h. + */ + +/* This file is part of LCDd, the lcdproc server. * + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. + * + * Copyright (c) 1999, William Ferrell, Scott Scriven + * 2002, Joris Robijn + * 2004, F5 Networks, Inc. - IP-address input + * 2005, Peter Marschall - error checks, ... */ #include diff --git a/server/menu.h b/server/menu.h index ed5b923..3042b31 100644 --- a/server/menu.h +++ b/server/menu.h @@ -1,16 +1,15 @@ -/* - * menu.h - * This file is part of LCDd, the lcdproc server. +/** \file server/menu.h + * Defines all the menu data and actions. + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2004, F5 Networks, Inc. - IP-address input * 2005, Peter Marschall - error checks, ... - * - * Defines all the menu data and actions. - * */ #include "menuitem.h" diff --git a/server/menuitem.c b/server/menuitem.c index 2217890..5a007cd 100644 --- a/server/menuitem.c +++ b/server/menuitem.c @@ -1,17 +1,16 @@ -/* - * menuitem.c - * This file is part of LCDd, the lcdproc server. +/** \file server/menuitem.c + * Handles a menuitem and all actions that can be performed on it. + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2002, Joris Robijn * 2004, F5 Networks, Inc. - IP-address input * 2005, Peter Marschall - error checks, ... - * - * - * Handles a menuitem and all actions that can be performed on it. */ #include diff --git a/server/menuitem.h b/server/menuitem.h index fff4345..a7ffe80 100644 --- a/server/menuitem.h +++ b/server/menuitem.h @@ -1,14 +1,4 @@ -/* - * menuitem.h - * This file is part of LCDd, the lcdproc server. - * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. - * - * Copyright (c) 1999, William Ferrell, Scott Scriven - * 2004, F5 Networks, Inc. - IP-address input - * 2005, Peter Marschall - error checks, ... - * +/** \file server/menuitem.h * Defines all the menuitem data and actions. * * There are a few different menuitems: @@ -24,6 +14,16 @@ * One menuitem is in a different file: Menu data is in menu,h. */ +/* This file is part of LCDd, the lcdproc server. + * + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. + * + * Copyright (c) 1999, William Ferrell, Scott Scriven + * 2004, F5 Networks, Inc. - IP-address input + * 2005, Peter Marschall - error checks, ... + */ + #ifndef MENUITEM_H #define MENUITEM_H diff --git a/server/menuscreens.c b/server/menuscreens.c index c43afcc..b6bb9a3 100644 --- a/server/menuscreens.c +++ b/server/menuscreens.c @@ -1,24 +1,23 @@ -/* - * menuscreens.c - * This file is part of LCDd, the lcdproc server. - * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. - * - * Copyright (c) 1999, William Ferrell, Scott Scriven - * 2002, Joris Robijn - * 2004, F5 Networks, Inc. - IP-address input - * 2005, Peter Marschall - error checks, ... - * - * +/** \file server/menuscreens.c * Creates the server menu screen(s) and creates the menus that should be * displayed on this screen. * It also handles its keypresses and converts them to menu tokens for * easier processing. * - * NOTE: menuscreens.c does not know whether a menuitem is displayed INSIDE + * \note + * menuscreens.c does not know whether a menuitem is displayed INSIDE * a menu or on a separate SCREEN, for flexibility. + */ + +/* This file is part of LCDd, the lcdproc server. * + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. + * + * Copyright (c) 1999, William Ferrell, Scott Scriven + * 2002, Joris Robijn + * 2004, F5 Networks, Inc. - IP-address input + * 2005, Peter Marschall - error checks, ... */ #include diff --git a/server/menuscreens.h b/server/menuscreens.h index c9acbd1..a7bbaf0 100644 --- a/server/menuscreens.h +++ b/server/menuscreens.h @@ -1,16 +1,15 @@ -/* - * menuscreens.h - * This file is part of LCDd, the lcdproc server. +/** \file server/menuscreens.h + * Creates all menuscreens, menus and handles the keypresses for the + * menuscreens. + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2003, Joris Robijn - * - * - * Creates all menuscreens, menus and handles the keypresses for the - * menuscreens. */ #ifndef MENUSCREENS_H diff --git a/server/parse.c b/server/parse.c index fb163cc..0dcb01c 100644 --- a/server/parse.c +++ b/server/parse.c @@ -1,4 +1,4 @@ -/** \file parse.c +/** \file server/parse.c * Handles input commands from clients, by splitting strings into tokens * and passing arguments to the appropriate handler. * @@ -8,12 +8,11 @@ /* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2008, Peter Marschall - * */ #include diff --git a/server/parse.h b/server/parse.h index d3680dc..f39d075 100644 --- a/server/parse.h +++ b/server/parse.h @@ -1,12 +1,12 @@ -/* - * parse.h - * This file is part of LCDd, the lcdproc server. +/** \file server/parse.h + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven - * */ #ifndef PARSE_H diff --git a/server/render.c b/server/render.c index 4694ee9..986c69f 100644 --- a/server/render.c +++ b/server/render.c @@ -1,14 +1,4 @@ -/* - * render.c - * This file is part of LCDd, the lcdproc server. - * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. - * - * Copyright (c) 1999, William Ferrell, Scott Scriven - * 2001, Joris Robijn - * 2007, Peter Marschall - * +/** \file server/render.c * Draws screens on the LCD. * * This needs to be greatly expanded and redone for greater flexibility. @@ -22,7 +12,16 @@ * NOTE: (from David Douthitt) Multiple screen sizes? Multiple simultaneous * screens? Horrors of horrors... next thing you know it'll be making coffee... * Better believe it'll take a while to do... + */ + +/* This file is part of LCDd, the lcdproc server. * + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. + * + * Copyright (c) 1999, William Ferrell, Scott Scriven + * 2001, Joris Robijn + * 2007, Peter Marschall */ #include diff --git a/server/render.h b/server/render.h index d4f70fe..653c94c 100644 --- a/server/render.h +++ b/server/render.h @@ -1,12 +1,12 @@ -/* - * render.h - * This file is part of LCDd, the lcdproc server. +/** \file server/render.h + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven - * */ #ifndef RENDER_H diff --git a/server/screen.c b/server/screen.c index df3bb27..4b3b1a1 100644 --- a/server/screen.c +++ b/server/screen.c @@ -1,16 +1,14 @@ -/* - * screen.c - * This file is part of LCDd, the lcdproc server. +/** \file server/screen.c + * Does screen management + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2003, Joris Robijn - * - * - * Does screen management - * */ #include diff --git a/server/screen.h b/server/screen.h index bf4ed0d..68d2a03 100644 --- a/server/screen.h +++ b/server/screen.h @@ -1,13 +1,13 @@ -/* - * screen.h - * This file is part of LCDd, the lcdproc server. +/** \file server/screen.h + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2003, Joris Robijn - * */ #include "menu.h" diff --git a/server/screenlist.c b/server/screenlist.c index 76737dc..3dce3d7 100644 --- a/server/screenlist.c +++ b/server/screenlist.c @@ -1,17 +1,15 @@ -/* - * screenlist.c - * This file is part of LCDd, the lcdproc server. +/** \file server/screenlist.c + * All actions that can be performed on the list of screens. + * This file also manages the rotation of screens. + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2003, Joris Robijn - * - * - * All actions that can be performed on the list of screens. - * This file also manages the rotation of screens. - * */ #include diff --git a/server/screenlist.h b/server/screenlist.h index 73a2c7d..76b5745 100644 --- a/server/screenlist.h +++ b/server/screenlist.h @@ -1,13 +1,13 @@ -/* - * screenlist.h - * This file is part of LCDd, the lcdproc server. +/** \file server/screenlist.h + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2003, Joris Robijn - * */ #ifndef SCREENLIST_H diff --git a/server/serverscreens.c b/server/serverscreens.c index cc0fc2c..af77c0a 100644 --- a/server/serverscreens.c +++ b/server/serverscreens.c @@ -1,17 +1,15 @@ -/** \file serverscreens.c +/** \file server/serverscreens.c * Implement the serverscreens. */ -/* - * This file is part of LCDd, the lcdproc server. +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2002, Joris Robijn * 2007, Peter Marschall - * */ #include diff --git a/server/serverscreens.h b/server/serverscreens.h index 9d68910..5d88a3f 100644 --- a/server/serverscreens.h +++ b/server/serverscreens.h @@ -1,15 +1,13 @@ -/** \file serverscreens.h +/** \file server/serverscreens.h * Interface for the serverscreen implementation. */ -/* - * This file is part of LCDd, the lcdproc server. +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven - * */ #ifndef SRVSTATS_H diff --git a/server/sock.c b/server/sock.c index cabe976..4403c58 100644 --- a/server/sock.c +++ b/server/sock.c @@ -1,17 +1,16 @@ -/** \file sock.c +/** \file server/sock.c * LCDproc sockets code. */ /* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2003, Benjamin Tse (blt@ieee.org) - Winsock port * 2004, F5 Networks, Inc. - IP-address input * 2005, Peter Marschall - error checks, ... - * */ #ifdef HAVE_CONFIG_H diff --git a/server/sock.h b/server/sock.h index 76c6fed..68576e4 100644 --- a/server/sock.h +++ b/server/sock.h @@ -1,11 +1,11 @@ -/** \file sock.h +/** \file server/sock.h * function declarations for LCDproc sockets code */ /* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2004, F5 Networks, Inc. - IP-address verification diff --git a/server/widget.c b/server/widget.c index d956b29..cb69898 100644 --- a/server/widget.c +++ b/server/widget.c @@ -1,16 +1,14 @@ -/* - * widget.c - * This file is part of LCDd, the lcdproc server. +/** \file server/widget.c + * Does all actions on widgets + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven * 2002, Joris Robijn - * - * - * Does all actions on widgets - * */ #include diff --git a/server/widget.h b/server/widget.h index de8df60..c67cb88 100644 --- a/server/widget.h +++ b/server/widget.h @@ -1,12 +1,12 @@ -/* - * widget.h - * This file is part of LCDd, the lcdproc server. +/** \file server/widget.h + */ + +/* This file is part of LCDd, the lcdproc server. * - * This file is released under the GNU General Public License. Refer to the - * COPYING file distributed with this package. + * This file is released under the GNU General Public License. + * Refer to the COPYING file distributed with this package. * * Copyright (c) 1999, William Ferrell, Scott Scriven - * */ #include "screen.h"