Doxygen-ize file headers

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 <stdlib.h>

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"

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 <stdio.h>

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

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 <stdlib.h>

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

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 <stdlib.h>

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

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.
  */
 
 

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

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

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

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 <stdlib.h>

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"

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 <stdlib.h>

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
 

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 <string.h>

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

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 <stdlib.h>

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

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 <string.h>

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

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 <stdlib.h>

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"

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 <stdlib.h>

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

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 <stdlib.h>

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

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

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

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 <stdlib.h>

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"