From 03628dbeaf40a9de34b3eb6d5bf6dd34eed8248c Mon Sep 17 00:00:00 2001 From: Alexander Barton Date: Mon, 27 Dec 2010 17:14:14 +0100 Subject: [PATCH] Add Doxygen @file documentation to each source and header file --- src/ipaddr/ng_ipaddr.c | 7 +++++-- src/ipaddr/ng_ipaddr.h | 7 +++++-- src/ngircd/array.c | 8 ++++++-- src/ngircd/array.h | 7 +++++-- src/ngircd/channel.c | 7 +++++-- src/ngircd/channel.h | 6 ++++-- src/ngircd/client.c | 7 +++++-- src/ngircd/client.h | 7 +++++-- src/ngircd/conf-ssl.h | 6 +++++- src/ngircd/conf.c | 7 +++++-- src/ngircd/conf.h | 7 +++++-- src/ngircd/conn-func.c | 7 +++++-- src/ngircd/conn-func.h | 6 ++++-- src/ngircd/conn-ssl.c | 8 ++++++-- src/ngircd/conn-ssl.h | 6 +++++- src/ngircd/conn-zip.c | 7 +++++-- src/ngircd/conn-zip.h | 8 ++++---- src/ngircd/conn.c | 7 +++++-- src/ngircd/conn.h | 6 ++++-- src/ngircd/hash.c | 9 +++++---- src/ngircd/hash.h | 10 +++++----- src/ngircd/io.c | 6 ++++-- src/ngircd/io.h | 9 +++++---- src/ngircd/irc-channel.c | 7 +++++-- src/ngircd/irc-channel.h | 8 ++++---- src/ngircd/irc-info.c | 7 +++++-- src/ngircd/irc-info.h | 8 ++++---- src/ngircd/irc-login.c | 7 +++++-- src/ngircd/irc-login.h | 7 +++++-- src/ngircd/irc-mode.c | 7 +++++-- src/ngircd/irc-mode.h | 8 ++++---- src/ngircd/irc-op.c | 7 +++++-- src/ngircd/irc-oper.c | 7 +++++-- src/ngircd/irc-oper.h | 8 ++++---- src/ngircd/irc-server.c | 7 +++++-- src/ngircd/irc-server.h | 8 ++++---- src/ngircd/irc-write.c | 7 +++++-- src/ngircd/irc-write.h | 7 +++++-- src/ngircd/irc.c | 7 ++++--- src/ngircd/irc.h | 7 +++++-- src/ngircd/lists.c | 7 +++++-- src/ngircd/lists.h | 8 ++++++-- src/ngircd/log.c | 7 +++++-- src/ngircd/log.h | 6 ++++-- src/ngircd/match.c | 7 ++++--- src/ngircd/match.h | 8 ++++---- src/ngircd/messages.h | 6 ++++-- src/ngircd/numeric.c | 7 +++++-- src/ngircd/numeric.h | 9 +++++---- src/ngircd/op.c | 7 +++++-- src/ngircd/op.h | 7 +++++-- src/ngircd/pam.c | 7 +++++-- src/ngircd/pam.h | 7 +++++-- src/ngircd/parse.h | 9 +++++---- src/ngircd/proc.c | 7 +++++-- src/ngircd/proc.h | 9 ++++++--- src/ngircd/resolve.c | 7 +++++-- src/ngircd/resolve.h | 7 +++++-- src/ngircd/sighandlers.h | 5 +++++ src/portab/exp.h | 8 ++++---- src/portab/imp.h | 8 ++++---- src/portab/portab.h | 6 ++++-- src/portab/portabtest.c | 7 ++++--- src/portab/splint.h | 15 ++++++++------- src/portab/strdup.c | 13 +++++++------ src/portab/strlcpy.c | 13 +++++++------ src/portab/strtok_r.c | 12 +++++++++++- src/portab/vsnprintf.c | 12 ++++-------- src/portab/waitpid.c | 12 +++++++----- src/tool/tool.c | 8 +++++--- src/tool/tool.h | 8 ++++++-- 71 files changed, 355 insertions(+), 193 deletions(-) diff --git a/src/ipaddr/ng_ipaddr.c b/src/ipaddr/ng_ipaddr.c index af524d09..a47a40d2 100644 --- a/src/ipaddr/ng_ipaddr.c +++ b/src/ipaddr/ng_ipaddr.c @@ -1,11 +1,14 @@ /* - * Functions for AF_ agnostic ipv4/ipv6 handling. - * * (c) 2008 Florian Westphal , public domain. */ #include "portab.h" +/** + * @file + * Functions for AF_ agnostic ipv4/ipv6 handling. + */ + #include #include #include diff --git a/src/ipaddr/ng_ipaddr.h b/src/ipaddr/ng_ipaddr.h index 54a97036..1f209ef9 100644 --- a/src/ipaddr/ng_ipaddr.h +++ b/src/ipaddr/ng_ipaddr.h @@ -1,6 +1,4 @@ /* - * Functions for AF_ agnostic ipv4/ipv6 handling. - * * (c) 2008 Florian Westphal , public domain. */ @@ -8,6 +6,11 @@ #define NG_IPADDR_HDR #include "portab.h" +/** + * @file + * Functions for AF_ agnostic ipv4/ipv6 handling (header). + */ + #include #include #include diff --git a/src/ngircd/array.c b/src/ngircd/array.c index 0fa96085..81569ce0 100644 --- a/src/ngircd/array.c +++ b/src/ngircd/array.c @@ -5,9 +5,13 @@ * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. * - * functions to dynamically allocate arrays. + * libarray - dynamically allocate arrays. * Copyright (c) 2005 Florian Westphal (westphal@foo.fh-furtwangen.de) - * + */ + +/** + * @file + * Functions to dynamically allocate arrays. */ #include "array.h" diff --git a/src/ngircd/array.h b/src/ngircd/array.h index b4aad9f7..f4611628 100644 --- a/src/ngircd/array.h +++ b/src/ngircd/array.h @@ -7,13 +7,16 @@ * * libarray - dynamically allocate arrays. * Copyright (c) 2005 Florian Westphal (westphal@foo.fh-furtwangen.de) - * - * $Id: array.h,v 1.4 2005/08/30 13:36:32 fw Exp $ */ #ifndef array_h_included #define array_h_included +/** + * @file + * Functions to dynamically allocate arrays (header). + */ + #include "portab.h" typedef struct { diff --git a/src/ngircd/channel.c b/src/ngircd/channel.c index c8c15d96..306f4dee 100644 --- a/src/ngircd/channel.c +++ b/src/ngircd/channel.c @@ -7,8 +7,6 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Channel management */ @@ -17,6 +15,11 @@ #include "portab.h" +/** + * @file + * Channel management + */ + #include "imp.h" #include #include diff --git a/src/ngircd/channel.h b/src/ngircd/channel.h index b912aab4..32623758 100644 --- a/src/ngircd/channel.h +++ b/src/ngircd/channel.h @@ -7,14 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Channel management (header) */ #ifndef __channel_h__ #define __channel_h__ +/** + * @file + * Channel management (header) + */ #if defined(__channel_c__) | defined(S_SPLINT_S) diff --git a/src/ngircd/client.c b/src/ngircd/client.c index 737c0184..7a6b275d 100644 --- a/src/ngircd/client.c +++ b/src/ngircd/client.c @@ -7,8 +7,6 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Client management. */ @@ -17,6 +15,11 @@ #include "portab.h" +/** + * @file + * Client management. + */ + #include "imp.h" #include #include diff --git a/src/ngircd/client.h b/src/ngircd/client.h index 42036c4e..9c7cde41 100644 --- a/src/ngircd/client.h +++ b/src/ngircd/client.h @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Client management (header) */ #ifndef __client_h__ #define __client_h__ +/** + * @file + * Client management (header) + */ + #define CLIENT_UNKNOWN 1 /* connection of unknown type */ #define CLIENT_GOTPASS 2 /* client did send PASS */ #define CLIENT_GOTNICK 4 /* client did send NICK */ diff --git a/src/ngircd/conf-ssl.h b/src/ngircd/conf-ssl.h index cdb99682..3fab579c 100644 --- a/src/ngircd/conf-ssl.h +++ b/src/ngircd/conf-ssl.h @@ -1,11 +1,15 @@ /* * ngIRCd -- The Next Generation IRC Daemon - * SSL defines. */ #ifndef conf_ssl_h #define conf_ssl_h +/** + * @file + * SSL related definitions + */ + #ifdef HAVE_LIBSSL #define SSL_SUPPORT #include diff --git a/src/ngircd/conf.c b/src/ngircd/conf.c index 6c0e3517..c2dde4b7 100644 --- a/src/ngircd/conf.c +++ b/src/ngircd/conf.c @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Configuration management (reading, parsing & validation) */ #include "portab.h" +/** + * @file + * Configuration management (reading, parsing & validation) + */ + #include "imp.h" #include #include diff --git a/src/ngircd/conf.h b/src/ngircd/conf.h index 5cb1e6b2..07fc1079 100644 --- a/src/ngircd/conf.h +++ b/src/ngircd/conf.h @@ -7,14 +7,17 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Configuration management (header) */ #ifndef __conf_h__ #define __conf_h__ +/** + * @file + * Configuration management (header) + */ + #include #include "defines.h" diff --git a/src/ngircd/conn-func.c b/src/ngircd/conn-func.c index 15bc7cc2..a50f0daa 100644 --- a/src/ngircd/conn-func.c +++ b/src/ngircd/conn-func.c @@ -7,8 +7,6 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Connection management: Global functions */ @@ -16,6 +14,11 @@ #include "portab.h" +/** + * @file + * Connection management: Global functions + */ + #include "imp.h" #include #include diff --git a/src/ngircd/conn-func.h b/src/ngircd/conn-func.h index d504592f..9f23edc8 100644 --- a/src/ngircd/conn-func.h +++ b/src/ngircd/conn-func.h @@ -7,14 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Connection management: Global functions (header) */ #ifndef __conn_func_h__ #define __conn_func_h__ +/** + * @file + * Connection management: Global functions (header) + */ /* Include the header conn.h if this header is _not_ included by any module * containing connection handling functions. So other modules must only diff --git a/src/ngircd/conn-ssl.c b/src/ngircd/conn-ssl.c index 6a0404f9..edcc5bd5 100644 --- a/src/ngircd/conn-ssl.c +++ b/src/ngircd/conn-ssl.c @@ -1,11 +1,15 @@ /* * ngIRCd -- The Next Generation IRC Daemon - * - * SSL wrapper functions. * Copyright (c) 2005-2008 Florian Westphal */ #include "portab.h" + +/** + * @file + * SSL wrapper functions + */ + #include "imp.h" #include "conf-ssl.h" diff --git a/src/ngircd/conn-ssl.h b/src/ngircd/conn-ssl.h index 4cb1bde0..aea0846f 100644 --- a/src/ngircd/conn-ssl.h +++ b/src/ngircd/conn-ssl.h @@ -1,11 +1,15 @@ /* * ngIRCd -- The Next Generation IRC Daemon - * SSL wrapper functions. (header) */ #ifndef conn_ssl_h #define conn_ssl_h +/** + * @file + * SSL wrapper functions (header) + */ + #include "conf-ssl.h" #include "conn.h" #include "conf.h" diff --git a/src/ngircd/conn-zip.c b/src/ngircd/conn-zip.c index 24577ed5..fa3a11e0 100644 --- a/src/ngircd/conn-zip.c +++ b/src/ngircd/conn-zip.c @@ -7,12 +7,15 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Connection compression using ZLIB */ #include "portab.h" +/** + * @file + * Connection compression using ZLIB + */ + #define CONN_MODULE #ifdef ZLIB diff --git a/src/ngircd/conn-zip.h b/src/ngircd/conn-zip.h index 08abb50c..7a5b1c4c 100644 --- a/src/ngircd/conn-zip.h +++ b/src/ngircd/conn-zip.h @@ -7,10 +7,6 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * $Id: conn-zip.h,v 1.4 2006/05/10 21:24:01 alex Exp $ - * - * Connection compression using ZLIB (header) */ @@ -19,6 +15,10 @@ #ifndef __conn_zip_h__ #define __conn_zip_h__ +/** + * @file + * Connection compression using ZLIB (header) + */ GLOBAL bool Zip_InitConn PARAMS(( CONN_ID Idx )); diff --git a/src/ngircd/conn.c b/src/ngircd/conn.c index e58e6335..e73dd306 100644 --- a/src/ngircd/conn.c +++ b/src/ngircd/conn.c @@ -7,8 +7,6 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Connection management */ @@ -18,6 +16,11 @@ #include "conf-ssl.h" #include "io.h" +/** + * @file + * Connection management + */ + #include "imp.h" #include #ifdef PROTOTYPES diff --git a/src/ngircd/conn.h b/src/ngircd/conn.h index 280c61bb..8ce5654d 100644 --- a/src/ngircd/conn.h +++ b/src/ngircd/conn.h @@ -7,14 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Connection management (header) */ #ifndef __conn_h__ #define __conn_h__ +/** + * @file + * Connection management (header) + */ #include /* for time_t, see below */ diff --git a/src/ngircd/hash.c b/src/ngircd/hash.c index 1b2f4e67..9bf42409 100644 --- a/src/ngircd/hash.c +++ b/src/ngircd/hash.c @@ -1,20 +1,21 @@ /* * ngIRCd -- The Next Generation IRC Daemon - * Copyright (c)2001-2009 Alexander Barton (alex@barton.de) + * Copyright (c)2001-2010 Alexander Barton (alex@barton.de) * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Hash calculation */ #include "portab.h" -static char UNUSED id[] = "$Id: hash.c,v 1.13 2006/10/06 21:23:47 fw Exp $"; +/** + * @file + * Hash calculation + */ #include "imp.h" #include diff --git a/src/ngircd/hash.h b/src/ngircd/hash.h index 577d1f52..684eeeee 100644 --- a/src/ngircd/hash.h +++ b/src/ngircd/hash.h @@ -7,18 +7,18 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * $Id: hash.h,v 1.6 2006/10/06 21:23:47 fw Exp $ - * - * Hash calculation (header) */ #ifndef __hash_h__ #define __hash_h__ -GLOBAL UINT32 Hash PARAMS((const char *String )); +/** + * @file + * Hash calculation (header) + */ +GLOBAL UINT32 Hash PARAMS((const char *String )); #endif diff --git a/src/ngircd/io.c b/src/ngircd/io.c index d13a5e25..fb39ecdd 100644 --- a/src/ngircd/io.c +++ b/src/ngircd/io.c @@ -5,14 +5,16 @@ * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. * - * I/O abstraction interface. * Copyright (c) 2005 Florian Westphal (westphal@foo.fh-furtwangen.de) * */ #include "portab.h" -static char UNUSED id[] = "$Id: io.c,v 1.31 2008/04/03 20:56:44 fw Exp $"; +/** + * @file + * I/O abstraction interface. + */ #include #include diff --git a/src/ngircd/io.h b/src/ngircd/io.h index 2f4c9645..556d752c 100644 --- a/src/ngircd/io.h +++ b/src/ngircd/io.h @@ -4,15 +4,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * I/O abstraction interface header - * - * $Id: io.h,v 1.4 2006/12/25 22:53:52 alex Exp $ */ #ifndef io_H_included #define io_H_included +/** + * @file + * I/O abstraction interface (header) + */ + #include "portab.h" #include diff --git a/src/ngircd/irc-channel.c b/src/ngircd/irc-channel.c index ed71dc70..1b8685d0 100644 --- a/src/ngircd/irc-channel.c +++ b/src/ngircd/irc-channel.c @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * IRC channel commands */ #include "portab.h" +/** + * @file + * IRC channel commands + */ + #include "imp.h" #include #include diff --git a/src/ngircd/irc-channel.h b/src/ngircd/irc-channel.h index d8bddbff..89bbafef 100644 --- a/src/ngircd/irc-channel.h +++ b/src/ngircd/irc-channel.h @@ -7,16 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * $Id: irc-channel.h,v 1.7 2005/03/19 18:43:48 fw Exp $ - * - * IRC channel commands (header) */ #ifndef __irc_channel_h__ #define __irc_channel_h__ +/** + * @file + * IRC channel commands (header) + */ GLOBAL bool IRC_JOIN PARAMS((CLIENT *Client, REQUEST *Req )); GLOBAL bool IRC_PART PARAMS((CLIENT *Client, REQUEST *Req )); diff --git a/src/ngircd/irc-info.c b/src/ngircd/irc-info.c index 9640a307..de2cd4d9 100644 --- a/src/ngircd/irc-info.c +++ b/src/ngircd/irc-info.c @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * IRC info commands */ #include "portab.h" +/** + * @file + * IRC info commands + */ + #include "imp.h" #include #include diff --git a/src/ngircd/irc-info.h b/src/ngircd/irc-info.h index fbebacc6..3ed03aa1 100644 --- a/src/ngircd/irc-info.h +++ b/src/ngircd/irc-info.h @@ -7,16 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * $Id: irc-info.h,v 1.6 2008/02/17 13:26:42 alex Exp $ - * - * IRC info commands (header) */ #ifndef __irc_info_h__ #define __irc_info_h__ +/** + * @file + * IRC info commands (header) + */ GLOBAL bool IRC_ADMIN PARAMS(( CLIENT *Client, REQUEST *Req )); GLOBAL bool IRC_INFO PARAMS(( CLIENT *Client, REQUEST *Req )); diff --git a/src/ngircd/irc-login.c b/src/ngircd/irc-login.c index 8af4df95..b310d8b8 100644 --- a/src/ngircd/irc-login.c +++ b/src/ngircd/irc-login.c @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Login and logout */ #include "portab.h" +/** + * @file + * Login and logout + */ + #include "imp.h" #include #include diff --git a/src/ngircd/irc-login.h b/src/ngircd/irc-login.h index 1504e0b7..f06a5ffa 100644 --- a/src/ngircd/irc-login.h +++ b/src/ngircd/irc-login.h @@ -7,14 +7,17 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Login and logout (header) */ #ifndef __irc_login_h__ #define __irc_login_h__ +/** + * @file + * Login and logout (header) + */ + GLOBAL bool IRC_PASS PARAMS((CLIENT *Client, REQUEST *Req)); GLOBAL bool IRC_NICK PARAMS((CLIENT *Client, REQUEST *Req)); GLOBAL bool IRC_USER PARAMS((CLIENT *Client, REQUEST *Req)); diff --git a/src/ngircd/irc-mode.c b/src/ngircd/irc-mode.c index 30f4dee3..5639ec18 100644 --- a/src/ngircd/irc-mode.c +++ b/src/ngircd/irc-mode.c @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * IRC commands for mode changes (MODE, AWAY, ...) */ #include "portab.h" +/** + * @file + * IRC commands for mode changes (like MODE, AWAY, etc.) + */ + #include "imp.h" #include #include diff --git a/src/ngircd/irc-mode.h b/src/ngircd/irc-mode.h index dd5d9dd0..9d13a7eb 100644 --- a/src/ngircd/irc-mode.h +++ b/src/ngircd/irc-mode.h @@ -7,16 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * $Id: irc-mode.h,v 1.6 2005/03/19 18:43:48 fw Exp $ - * - * IRC commands for mode changes (header) */ #ifndef __irc_mode_h__ #define __irc_mode_h__ +/** + * @file + * IRC commands for mode changes (header) + */ GLOBAL bool IRC_MODE PARAMS((CLIENT *Client, REQUEST *Req )); GLOBAL bool IRC_AWAY PARAMS((CLIENT *Client, REQUEST *Req )); diff --git a/src/ngircd/irc-op.c b/src/ngircd/irc-op.c index e4d6f3b7..34b0eb0f 100644 --- a/src/ngircd/irc-op.c +++ b/src/ngircd/irc-op.c @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Channel operator commands */ #include "portab.h" +/** + * @file + * Channel operator commands + */ + #include "imp.h" #include #include diff --git a/src/ngircd/irc-oper.c b/src/ngircd/irc-oper.c index 048c4f8b..7887ef60 100644 --- a/src/ngircd/irc-oper.c +++ b/src/ngircd/irc-oper.c @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * IRC operator commands */ #include "portab.h" +/** + * @file + * IRC operator commands + */ + #include "imp.h" #include #include diff --git a/src/ngircd/irc-oper.h b/src/ngircd/irc-oper.h index 8b867c45..6d7600f9 100644 --- a/src/ngircd/irc-oper.h +++ b/src/ngircd/irc-oper.h @@ -7,16 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * $Id: irc-oper.h,v 1.12 2007/08/02 10:14:26 fw Exp $ - * - * IRC operator commands (header) */ #ifndef __irc_oper_h__ #define __irc_oper_h__ +/** + * @file + * IRC operator commands (header) + */ GLOBAL bool IRC_OPER PARAMS((CLIENT *Client, REQUEST *Req )); GLOBAL bool IRC_DIE PARAMS((CLIENT *Client, REQUEST *Req )); diff --git a/src/ngircd/irc-server.c b/src/ngircd/irc-server.c index e7ff726a..8877a13c 100644 --- a/src/ngircd/irc-server.c +++ b/src/ngircd/irc-server.c @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * IRC commands for server links */ #include "portab.h" +/** + * @file + * IRC commands for server links + */ + #include "imp.h" #include #include diff --git a/src/ngircd/irc-server.h b/src/ngircd/irc-server.h index 9940d791..072f16cc 100644 --- a/src/ngircd/irc-server.h +++ b/src/ngircd/irc-server.h @@ -7,16 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * $Id: irc-server.h,v 1.6 2007/11/21 12:16:36 alex Exp $ - * - * IRC commands for server links (header) */ #ifndef __irc_server_h__ #define __irc_server_h__ +/** + * @file + * IRC commands for server links (header) + */ GLOBAL bool IRC_SERVER PARAMS((CLIENT *Client, REQUEST *Req )); GLOBAL bool IRC_NJOIN PARAMS((CLIENT *Client, REQUEST *Req )); diff --git a/src/ngircd/irc-write.c b/src/ngircd/irc-write.c index 07aadf48..077b45ef 100644 --- a/src/ngircd/irc-write.c +++ b/src/ngircd/irc-write.c @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Sending IRC commands over the network */ #include "portab.h" +/** + * @file + * Sending IRC commands over the network + */ + #include "imp.h" #include #ifdef PROTOTYPES diff --git a/src/ngircd/irc-write.h b/src/ngircd/irc-write.h index f0543149..dc8dec20 100644 --- a/src/ngircd/irc-write.h +++ b/src/ngircd/irc-write.h @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Sending IRC commands over the network (header) */ #ifndef __irc_write_h__ #define __irc_write_h__ +/** + * @file + * Sending IRC commands over the network (header) + */ + GLOBAL bool IRC_WriteStrClient PARAMS((CLIENT *Client, const char *Format, ...)); GLOBAL bool IRC_WriteStrClientPrefix PARAMS((CLIENT *Client, CLIENT *Prefix, const char *Format, ...)); diff --git a/src/ngircd/irc.c b/src/ngircd/irc.c index 75af3211..9e2aaeaf 100644 --- a/src/ngircd/irc.c +++ b/src/ngircd/irc.c @@ -7,14 +7,15 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * IRC commands */ #include "portab.h" -static char UNUSED id[] = "$Id: irc.c,v 1.132 2008/01/15 22:28:14 fw Exp $"; +/** + * @file + * IRC commands + */ #include "imp.h" #include diff --git a/src/ngircd/irc.h b/src/ngircd/irc.h index 358d91ac..cdeb7458 100644 --- a/src/ngircd/irc.h +++ b/src/ngircd/irc.h @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * IRC commands (header) */ #ifndef __irc_h__ #define __irc_h__ +/** + * @file + * IRC commands (header) + */ + GLOBAL bool IRC_ERROR PARAMS((CLIENT *Client, REQUEST *Req)); GLOBAL bool IRC_KILL PARAMS((CLIENT *Client, REQUEST *Req)); GLOBAL bool IRC_NOTICE PARAMS((CLIENT *Client, REQUEST *Req)); diff --git a/src/ngircd/lists.c b/src/ngircd/lists.c index 58c5d160..cde928f6 100644 --- a/src/ngircd/lists.c +++ b/src/ngircd/lists.c @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Management of IRC lists: ban, invite, ... */ #include "portab.h" +/** + * @file + * Management of IRC lists: ban, invite, etc. + */ + #include "imp.h" #include diff --git a/src/ngircd/lists.h b/src/ngircd/lists.h index 6458e782..c39325ea 100644 --- a/src/ngircd/lists.h +++ b/src/ngircd/lists.h @@ -7,13 +7,17 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Management of IRC lists: ban, invite, ... (header) */ #ifndef __lists_h__ #define __lists_h__ + +/** + * @file + * Management of IRC lists (header) + */ + #include "portab.h" #include "client.h" diff --git a/src/ngircd/log.c b/src/ngircd/log.c index 0bc53ed8..ea9b367a 100644 --- a/src/ngircd/log.c +++ b/src/ngircd/log.c @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Logging functions */ #include "portab.h" +/** + * @file + * Logging functions + */ + #include "imp.h" #include #include diff --git a/src/ngircd/log.h b/src/ngircd/log.h index 9fdb8a29..b8546cdd 100644 --- a/src/ngircd/log.h +++ b/src/ngircd/log.h @@ -7,14 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Logging functions (header) */ #ifndef __log_h__ #define __log_h__ +/** + * @file + * Logging functions (header) + */ #ifdef SYSLOG # include diff --git a/src/ngircd/match.c b/src/ngircd/match.c index 5e97e71f..6c28938e 100644 --- a/src/ngircd/match.c +++ b/src/ngircd/match.c @@ -7,14 +7,15 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Wildcard pattern matching */ #include "portab.h" -static char UNUSED id[] = "$Id: match.c,v 1.5 2006/10/06 21:23:47 fw Exp $"; +/** + * @file + * Wildcard pattern matching + */ #include "imp.h" #include diff --git a/src/ngircd/match.h b/src/ngircd/match.h index 0e8df74a..b092b967 100644 --- a/src/ngircd/match.h +++ b/src/ngircd/match.h @@ -7,16 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * $Id: match.h,v 1.4 2006/10/06 21:23:47 fw Exp $ - * - * Wildcard pattern matching (header) */ #ifndef __match_h__ #define __match_h__ +/** + * @file + * Wildcard pattern matching (header) + */ GLOBAL bool Match PARAMS(( const char *Pattern, const char *String )); GLOBAL bool MatchCaseInsensitive PARAMS(( const char *Pattern, const char *searchme )); diff --git a/src/ngircd/messages.h b/src/ngircd/messages.h index ec4bd869..07df4e45 100644 --- a/src/ngircd/messages.h +++ b/src/ngircd/messages.h @@ -7,14 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * IRC numerics (Header) */ #ifndef __messages_h__ #define __messages_h__ +/** + * @file + * IRC numerics (Header) + */ #define RPL_WELCOME_MSG "001 %s :Welcome to the Internet Relay Network %s" #define RPL_YOURHOST_MSG "002 %s :Your host is %s, running version ngircd-%s (%s/%s/%s)" diff --git a/src/ngircd/numeric.c b/src/ngircd/numeric.c index 0dcfe75b..ba6c0254 100644 --- a/src/ngircd/numeric.c +++ b/src/ngircd/numeric.c @@ -7,12 +7,15 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Handlers for IRC numerics sent to the server */ #include "portab.h" +/** + * @file + * Handlers for IRC numerics sent to the server + */ + #include "imp.h" #include #include diff --git a/src/ngircd/numeric.h b/src/ngircd/numeric.h index eca11bae..d9efa4b2 100644 --- a/src/ngircd/numeric.h +++ b/src/ngircd/numeric.h @@ -7,15 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * $Id: numeric.h,v 1.1 2007/11/21 12:20:32 alex Exp $ - * - * Handlers for IRC numerics sent to the server (header) */ #ifndef __numeric_h__ #define __numeric_h__ +/** + * @file + * Handlers for IRC numerics sent to the server (header) + */ + GLOBAL bool IRC_Num_ENDOFMOTD PARAMS((CLIENT *Client, UNUSED REQUEST *Req)); GLOBAL bool IRC_Num_ISUPPORT PARAMS((CLIENT *Client, REQUEST *Req)); diff --git a/src/ngircd/op.c b/src/ngircd/op.c index c70be6e4..64c7e1e1 100644 --- a/src/ngircd/op.c +++ b/src/ngircd/op.c @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * IRC operator functions */ #include "portab.h" +/** + * @file + * IRC operator functions + */ + #include "imp.h" #include #include diff --git a/src/ngircd/op.h b/src/ngircd/op.h index 544be25a..a1a84a33 100644 --- a/src/ngircd/op.h +++ b/src/ngircd/op.h @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Operator management (header) */ #ifndef __oper_h__ #define __oper_h__ +/** + * @file + * IRC operator functions (header) + */ + GLOBAL bool Op_NoPrivileges PARAMS((CLIENT * Client, REQUEST * Req)); GLOBAL bool Op_Check PARAMS((CLIENT * Client, REQUEST * Req)); diff --git a/src/ngircd/pam.c b/src/ngircd/pam.c index 0d4f27f0..b28e866f 100644 --- a/src/ngircd/pam.c +++ b/src/ngircd/pam.c @@ -7,14 +7,17 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * PAM User Authentification */ #include "portab.h" #ifdef PAM +/** + * @file + * PAM User Authentification + */ + #include "imp.h" #include diff --git a/src/ngircd/pam.h b/src/ngircd/pam.h index 74b838d0..ba31d50a 100644 --- a/src/ngircd/pam.h +++ b/src/ngircd/pam.h @@ -7,8 +7,6 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * PAM User Authentification (header) */ #ifdef PAM @@ -16,6 +14,11 @@ #ifndef __pam_h__ #define __pam_h__ +/** + * @file + * PAM User Authentification (header) + */ + GLOBAL bool PAM_Authenticate PARAMS((CLIENT *Client)); #endif /* __pam_h__ */ diff --git a/src/ngircd/parse.h b/src/ngircd/parse.h index 205dbb8d..ef42be14 100644 --- a/src/ngircd/parse.h +++ b/src/ngircd/parse.h @@ -7,16 +7,17 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * $Id: parse.h,v 1.13 2008/01/13 16:12:49 fw Exp $ - * - * IRC command parser and validator (header) */ #ifndef __parse_h__ #define __parse_h__ +/** + * @file + * IRC command parser and validator (header) + */ + #include "portab.h" typedef struct _REQUEST /* vgl. RFC 2812, 2.3 */ diff --git a/src/ngircd/proc.c b/src/ngircd/proc.c index 614aef4c..aace8053 100644 --- a/src/ngircd/proc.c +++ b/src/ngircd/proc.c @@ -7,12 +7,15 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Process management */ #include "portab.h" +/** + * @file + * Process management + */ + #include "imp.h" #include #include diff --git a/src/ngircd/proc.h b/src/ngircd/proc.h index 57612f17..bb4bceb2 100644 --- a/src/ngircd/proc.h +++ b/src/ngircd/proc.h @@ -7,14 +7,17 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Process management (header) */ #ifndef __proc_h__ #define __proc_h__ -/* This struct must not be accessed directly! */ +/** + * @file + * Process management (header) + */ + +/** Process status. This struct must not be accessed directly! */ typedef struct _Proc_Stat { pid_t pid; /* PID of the child process or 0 if none */ int pipe_fd; /* Pipe file descriptor or -1 if none */ diff --git a/src/ngircd/resolve.c b/src/ngircd/resolve.c index 5839c194..ce1bf0d5 100644 --- a/src/ngircd/resolve.c +++ b/src/ngircd/resolve.c @@ -7,8 +7,6 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Asynchronous resolver */ @@ -16,6 +14,11 @@ #include "portab.h" +/** + * @file + * Asynchronous resolver + */ + #include "imp.h" #include #include diff --git a/src/ngircd/resolve.h b/src/ngircd/resolve.h index 044ceec1..c0b734b8 100644 --- a/src/ngircd/resolve.h +++ b/src/ngircd/resolve.h @@ -7,13 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Asynchronous resolver (header) */ #ifndef __resolve_h__ #define __resolve_h__ +/** + * @file + * Asynchronous resolver (header) + */ + GLOBAL bool Resolve_Addr PARAMS((PROC_STAT * s, const ng_ipaddr_t * Addr, int identsock, void (*cbfunc) (int, short))); GLOBAL bool Resolve_Name PARAMS((PROC_STAT * s, const char *Host, diff --git a/src/ngircd/sighandlers.h b/src/ngircd/sighandlers.h index 98f91e8f..87c693aa 100644 --- a/src/ngircd/sighandlers.h +++ b/src/ngircd/sighandlers.h @@ -11,6 +11,11 @@ #ifndef signals_included_ #define signals_included_ +/** + * @file + * Signal Handlers (header). + */ + #include "portab.h" bool Signals_Init PARAMS((void)); diff --git a/src/portab/exp.h b/src/portab/exp.h index 0cb2d200..db6fb7ee 100644 --- a/src/portab/exp.h +++ b/src/portab/exp.h @@ -8,12 +8,12 @@ * der Lizenz oder (wenn Sie es wuenschen) jeder spaeteren Version. * Naehere Informationen entnehmen Sie bitter der Datei COPYING. Eine Liste * der an ngIRCd beteiligten Autoren finden Sie in der Datei AUTHORS. - * - * $Id: exp.h,v 1.1 2002/03/12 14:36:44 alex Exp $ - * - * exp.h: "Export Header" */ +/** + * @file + * "Export Header" which makes sure, that global functions are not "extern". + */ #undef GLOBAL #define GLOBAL diff --git a/src/portab/imp.h b/src/portab/imp.h index cc51d892..2c26e57d 100644 --- a/src/portab/imp.h +++ b/src/portab/imp.h @@ -8,12 +8,12 @@ * der Lizenz oder (wenn Sie es wuenschen) jeder spaeteren Version. * Naehere Informationen entnehmen Sie bitter der Datei COPYING. Eine Liste * der an ngIRCd beteiligten Autoren finden Sie in der Datei AUTHORS. - * - * $Id: imp.h,v 1.1 2002/03/12 14:36:44 alex Exp $ - * - * imp.h: "Import Header" */ +/** + * @file + * "Import Header" which makes sure that global functions are defined "extern". + */ #undef GLOBAL #define GLOBAL extern diff --git a/src/portab/portab.h b/src/portab/portab.h index d2f769f1..cb00dfaf 100644 --- a/src/portab/portab.h +++ b/src/portab/portab.h @@ -7,14 +7,16 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Portability functions and declarations (header for libngbportab). */ #ifndef __PORTAB__ #define __PORTAB__ +/** + * @file + * Portability functions and declarations (header) + */ #include "config.h" diff --git a/src/portab/portabtest.c b/src/portab/portabtest.c index 0a2098ed..2675409a 100644 --- a/src/portab/portabtest.c +++ b/src/portab/portabtest.c @@ -7,14 +7,15 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * test program for portab.h and friends ;-) */ #include "portab.h" -static char UNUSED id[] = "$Id: portabtest.c,v 1.13 2005/07/31 20:13:11 alex Exp $"; +/** + * @file + * Test program for portab.h and friends ;-) + */ #include "imp.h" #include diff --git a/src/portab/splint.h b/src/portab/splint.h index 2f606a02..74dd120f 100644 --- a/src/portab/splint.h +++ b/src/portab/splint.h @@ -8,19 +8,20 @@ * der Lizenz oder (wenn Sie es wuenschen) jeder spaeteren Version. * Naehere Informationen entnehmen Sie bitter der Datei COPYING. Eine Liste * der an ngIRCd beteiligten Autoren finden Sie in der Datei AUTHORS. - * - * $Id: splint.h,v 1.1 2002/03/25 19:13:19 alex Exp $ - * - * splint.h: spezieller Header fuer SPLint Code-Check - * - * Dieser Header wird von portab.h nur dann includiert, wenn ein Code-Check - * mit SPLint laeufr (d.h. S_SPLINT_S definiert ist). */ #ifndef __splint__ #define __splint__ +/** + * @file + * Header file which is included for SPLint code checks + * + * This header is only included by portab.h if a SPLint code check is + * running (when S_SPLINT_S is defined). It makes some definitions to + * prevent SPLint from issuing false warnings. + */ #define SYSCONFDIR "/" #define LOCALSTATEDIR "/" diff --git a/src/portab/strdup.c b/src/portab/strdup.c index e7351570..7c0ee8fd 100644 --- a/src/portab/strdup.c +++ b/src/portab/strdup.c @@ -1,13 +1,16 @@ /* * ngIRCd -- The Next Generation IRC Daemon - * - * strdup() implementation. Public domain. - * - * $Id: strdup.c,v 1.1 2005/04/16 09:20:53 fw Exp $ */ #include "portab.h" +/** + * @file + * strdup() implementation. Public domain. + */ + +#ifndef HAVE_STRDUP + #include "imp.h" #include #include @@ -15,8 +18,6 @@ #include "exp.h" -#ifndef HAVE_STRDUP - GLOBAL char * strdup( const char *s ) { diff --git a/src/portab/strlcpy.c b/src/portab/strlcpy.c index ee93d1d6..ae2018bc 100644 --- a/src/portab/strlcpy.c +++ b/src/portab/strlcpy.c @@ -7,8 +7,14 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * + */ + +#include "portab.h" + +/** + * @file * strlcpy() and strlcat() replacement functions. + * * See for details. * * Code partially borrowed from compat.c of rsync, written by Andrew @@ -16,11 +22,6 @@ * */ - -#include "portab.h" - -static char UNUSED id[] = "$Id: strlcpy.c,v 1.5 2005/03/19 18:43:50 fw Exp $"; - #include "imp.h" #include #include diff --git a/src/portab/strtok_r.c b/src/portab/strtok_r.c index 852c8f70..043898e9 100644 --- a/src/portab/strtok_r.c +++ b/src/portab/strtok_r.c @@ -1,8 +1,18 @@ +/* + * ngIRCd -- The Next Generation IRC Daemon + */ + #include "portab.h" -#include + +/** + * @file + * Implementation of strtok_r() + */ #ifndef HAVE_STRTOK_R +#include + char * strtok_r(char *str, const char *delim, char **saveptr) { diff --git a/src/portab/vsnprintf.c b/src/portab/vsnprintf.c index 3f9707b7..081152e1 100644 --- a/src/portab/vsnprintf.c +++ b/src/portab/vsnprintf.c @@ -7,19 +7,15 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * snprintf() and vsnprintf() replacement functions */ #include "portab.h" -static char UNUSED id[] = "$Id: vsnprintf.c,v 1.5 2003/04/21 10:53:38 alex Exp $"; - -#include "imp.h" - -#include "exp.h" - +/** + * @file + * snprintf() and vsnprintf() replacement functions + */ /* * snprintf.c: Copyright Patrick Powell 1995 diff --git a/src/portab/waitpid.c b/src/portab/waitpid.c index 0c169601..5846bd8f 100644 --- a/src/portab/waitpid.c +++ b/src/portab/waitpid.c @@ -1,12 +1,16 @@ /* * ngIRCd -- The Next Generation IRC Daemon - * + */ + +#include "portab.h" + +/** + * @file * waitpid() implementation. Public domain. * Written by Steven D. Blackford for the NeXT system. - * */ -#include "portab.h" +#ifndef HAVE_WAITPID #include "imp.h" #include @@ -15,8 +19,6 @@ #include "exp.h" -#ifndef HAVE_WAITPID - GLOBAL int waitpid(pid, stat_loc, options) int pid, *stat_loc, options; diff --git a/src/tool/tool.c b/src/tool/tool.c index dbdb49a2..ef3fb5d7 100644 --- a/src/tool/tool.c +++ b/src/tool/tool.c @@ -7,13 +7,15 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Tool functions */ - #include "portab.h" +/** + * @file + * Tool functions + */ + #include "imp.h" #include #include diff --git a/src/tool/tool.h b/src/tool/tool.h index 4513a232..ba52f66b 100644 --- a/src/tool/tool.h +++ b/src/tool/tool.h @@ -7,13 +7,17 @@ * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * Please read the file COPYING, README and AUTHORS for more information. - * - * Tool functions (Header) */ #ifndef __tool_h__ #define __tool_h__ + +/** + * @file + * Tool functions (Header) + */ + #include "portab.h" #ifdef HAVE_ARPA_INET_H -- 2.39.2