commit 03628dbeaf40a9de34b3eb6d5bf6dd34eed8248c from: Alexander Barton date: Sun Feb 13 16:52:38 2011 UTC Add Doxygen @file documentation to each source and header file commit - 408cefd15d4540d340283cdfbfad62a8e432cf8e commit + 03628dbeaf40a9de34b3eb6d5bf6dd34eed8248c blob - af524d091fa569dd874559a3f032f5dcc0cfde6d blob + a47a40d2a245bc0856ff03a853a66606ba1b3e00 --- src/ipaddr/ng_ipaddr.c +++ 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 blob - 54a970362e5084e0193a6ea21519213dcd41038b blob + 1f209ef9fb734ab4ac05b7d488c2a5ea1ebe7c4f --- src/ipaddr/ng_ipaddr.h +++ 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 blob - 0fa960857dda156fe1ee8eeaf7ae8ec4040403c6 blob + 81569ce07e1f45ebab4cb4a925b4d498d2e006bd --- src/ngircd/array.c +++ 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" blob - b4aad9f7fcf156d000ec9be59fadeb0d06958a73 blob + f461162834bcebed746d54fe9d2fa29d569a75c6 --- src/ngircd/array.h +++ 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 { blob - c8c15d96c3a6033d401a3e61be5caf69e5c3b2aa blob + 306f4deec0d1db5def2139a80730dcd482d3fcc5 --- src/ngircd/channel.c +++ 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 blob - b912aab4dc5260b7c447e704b3246976741d0d7e blob + 32623758744f9acc5f120f6c69621d7f8ff2ef51 --- src/ngircd/channel.h +++ 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) blob - 737c01841c7381ece36543ba7e203842118ac93a blob + 7a6b275da5918ea0030a12f4aa97804d980cd6ee --- src/ngircd/client.c +++ 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 blob - 42036c4e79f89c164b6f2dd13b499543bcd1a3ab blob + 9c7cde4113bd75a1e87ed58ec083d18e882837ed --- src/ngircd/client.h +++ 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 */ blob - cdb996828c4b0e68dd8e0f8ce01823e254bda953 blob + 3fab579ca7c41983756d38dc3f968e1e2abfc2fe --- src/ngircd/conf-ssl.h +++ 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 blob - 6c0e35170efd85e87d1c9a1395599afa12c88cf5 blob + c2dde4b79e3a6f6747cdbef3ce60a999571636c8 --- src/ngircd/conf.c +++ 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 blob - 5cb1e6b23156e8fd8dd6b3ba8985c8f39f91d233 blob + 07fc1079b610f70f5b89ad4f9b57383e074813cc --- src/ngircd/conf.h +++ 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" blob - 15bc7cc2663c1f0b94ff21e58da7043274ce17e2 blob + a50f0daadded8806ad0a6be459da4762fde6bf0e --- src/ngircd/conn-func.c +++ 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 blob - d504592f9a76a9e51590158819805341939db298 blob + 9f23edc810013cb24b671c6f97f00358cde8badb --- src/ngircd/conn-func.h +++ 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 blob - 6a0404f9e052e6b5e463505d711d3a95f1f48f8e blob + edcc5bd567a3af074a2cf0af2f5ff6fab5978bcf --- src/ngircd/conn-ssl.c +++ 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" blob - 4cb1bde0efa2d912c9fad4a985b97dc26f581bf1 blob + aea0846f46cb2036b15cff074678e7df482a953e --- src/ngircd/conn-ssl.h +++ 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" blob - 24577ed525da167eac177528f78594235b580e1a blob + fa3a11e0a4e15b5da56ed6eb0d7c71fd77a17a0f --- src/ngircd/conn-zip.c +++ 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 blob - 08abb50ca70fa542d943bbcd4388ab4c1c713301 blob + 7a5b1c4cd77b641b0a29ac8f41576b46c02b103d --- src/ngircd/conn-zip.h +++ 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 )); blob - e58e6335a2a2cb298bbcf83703f7b7ccb666ddd2 blob + e73dd3060e9d51887f21a610418c34b408e4c7f6 --- src/ngircd/conn.c +++ 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 blob - 280c61bb8dea77b0b39070607ebecc91fa30ec13 blob + 8ce5654da2c294dd5e4b014119f827600c4e9c49 --- src/ngircd/conn.h +++ 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 */ blob - 1b2f4e678b412df818c53d81a7c7c91dc2f753f6 blob + 9bf4240903c63e56780e12e1069e767e9386942d --- src/ngircd/hash.c +++ 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 blob - 577d1f52711b50790af510d809a31efbc25ac01a blob + 684eeeeef02204eb8218f32eac671bd1ea480fbc --- src/ngircd/hash.h +++ src/ngircd/hash.h @@ -7,19 +7,19 @@ * 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__ +/** + * @file + * Hash calculation (header) + */ + GLOBAL UINT32 Hash PARAMS((const char *String )); - #endif blob - d13a5e25b0b2dec413198e7feb494ca0cd2e14aa blob + fb39ecdd99f0b07cb96c6afd61ef05a40468eaa3 --- src/ngircd/io.c +++ 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 blob - 2f4c964551d31627ae8ba743b700378979d6cc9c blob + 556d752cab50b17accae64ac9824d5657c468c60 --- src/ngircd/io.h +++ 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 blob - ed71dc70bc683d3e3b0e7622e2f62798d881723e blob + 1b8685d03f5b1886902261d4cc9da9b23638131b --- src/ngircd/irc-channel.c +++ 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 blob - d8bddbff04bc186431825253351aba8309ec53e9 blob + 89bbafef96459fd1aa468906f7a6fed5f5fd1a1c --- src/ngircd/irc-channel.h +++ 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 )); blob - 9640a307977b43fc5f3b8bd56ec4994b894c3b92 blob + de2cd4d9bfd250448b9a86f561269d9ef0e334a3 --- src/ngircd/irc-info.c +++ 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 blob - fbebacc67d969d11617c874dcc41f22f0f58e496 blob + 3ed03aa102d067886d856eaf1d6e6671d5e5cb55 --- src/ngircd/irc-info.h +++ 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 )); blob - 8af4df95f6957171a42b1432e660266afd7589f4 blob + b310d8b84614e7a37737825518125d9eb78ca705 --- src/ngircd/irc-login.c +++ 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 blob - 1504e0b7317a0d48e32c991bf57dd11fa622ca7b blob + f06a5ffae80ff36d486b66cf733ea287e26549e9 --- src/ngircd/irc-login.h +++ 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)); blob - 30f4dee3ef26b9249c1d9f1aba76802c01df0c1d blob + 5639ec1880b237010123c3c15c33f57cc1ca5b2f --- src/ngircd/irc-mode.c +++ 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 blob - dd5d9dd007518ff9dfba511999bbaed68872c820 blob + 9d13a7eb957e701b7b346dd6457b9d7a084e914d --- src/ngircd/irc-mode.h +++ 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 )); blob - e4d6f3b7d34679d6e1f1c91b851348ece1c7d866 blob + 34b0eb0f8e1fea9e00a0087947088b0978a3711e --- src/ngircd/irc-op.c +++ 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 blob - 048c4f8b099f335caf6d339655e85bc4bc24dd10 blob + 7887ef6075260dd670d907a5e86e8fe322e8b247 --- src/ngircd/irc-oper.c +++ 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 blob - 8b867c45ae486e9079bda580032a25f2e81735f3 blob + 6d7600f9d36e1b208232add09886b6021e2ec796 --- src/ngircd/irc-oper.h +++ 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 )); blob - e7ff726a208dce9c4c857962d3ed84fcdc4bc1b5 blob + 8877a13c7e09ea7f0fa6ac6196336a119fc61dd3 --- src/ngircd/irc-server.c +++ 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 blob - 9940d79117f98b5a9fc2ab2880f8aa7124678c0d blob + 072f16cc46782bb6e9f59887fcf50550500cf4a6 --- src/ngircd/irc-server.h +++ 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 )); blob - 07aadf484c5c235398459c43366e807874a3b439 blob + 077b45ef621c8e15504052a93969375f5b1df490 --- src/ngircd/irc-write.c +++ 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 blob - f0543149e08ec55e42932a3bcbd66bdb11365b4e blob + dc8dec209157a64c9ad6cdcf625291ec17fbaca9 --- src/ngircd/irc-write.h +++ 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, ...)); blob - 75af32111d835a9a812e495cb8bff63ad1e75658 blob + 9e2aaeaf64fec42d746851f5b6f9d5e63d5b9a88 --- src/ngircd/irc.c +++ 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 blob - 358d91ac5bc8032a0c5f1fc3809b348a51ffb142 blob + cdeb74580984c2fee70198d83cb81e6e05c67649 --- src/ngircd/irc.h +++ 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)); blob - 58c5d160df0913199c98547973a48cc97a4f69f0 blob + cde928f6bf9c0301b260d5fb25b1cf89b2dbfaca --- src/ngircd/lists.c +++ 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 blob - 6458e7825377e2f55e9cedde0f423687d9d27081 blob + c39325ea0ea869bf646e5495eeb812fe6066335d --- src/ngircd/lists.h +++ 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" blob - 0bc53ed8dc2b3b9a1afea84cadfea528eed33785 blob + ea9b367a799ca4875b0560118e2a95a65cfa3a64 --- src/ngircd/log.c +++ 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 blob - 9fdb8a29adddbde629af3294c8727ed1dcf3bdf6 blob + b8546cdd57edc44a09544754248094105b18c738 --- src/ngircd/log.h +++ 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 blob - 5e97e71fc15e5476b2f7935b75d2a0d4ebc35330 blob + 6c28938ef9bb4fc0dc19b3e8d82ed8dd7c3ffef7 --- src/ngircd/match.c +++ 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 blob - 0e8df74a25df204f50ce896247c12a9c81ea3134 blob + b092b967ffb026e576d133d92148faf074e93c2f --- src/ngircd/match.h +++ 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 )); blob - ec4bd869df928aeec2e22a2fb554e9ba45d068aa blob + 07df4e45b0d16b84e2abb23b184a2f0971a49625 --- src/ngircd/messages.h +++ 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)" blob - 0dcfe75b6e3d9c0bca6ad9d7b7a0ead4876aaa74 blob + ba6c0254f7e32b1890723a9d3a0e0ad4fa0deb6d --- src/ngircd/numeric.c +++ 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 blob - eca11bae23812bb2b61b2aecf09d9aacc4dd4494 blob + d9efa4b2190f943eea6db2c155f325f8e0350c56 --- src/ngircd/numeric.h +++ 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)); blob - c70be6e47f1b1dffa6128c88cfd04f2900bd854f blob + 64c7e1e1fb2142e0bd6f3c5850220c669a422756 --- src/ngircd/op.c +++ 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 blob - 544be25a8650d273492d4a3c501780dd1edc35f3 blob + a1a84a330dc8caf105192ed474c7e000c96001a8 --- src/ngircd/op.h +++ 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)); blob - 0d4f27f066c91dae8da42e21ec0f3136ce03af0a blob + b28e866f42324d4b497f998ad34a8021205233c3 --- src/ngircd/pam.c +++ 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 blob - 74b838d00f267029f218e542fd5270c3b4fa1d30 blob + ba31d50abd893f9f8dea941df1311c9ae14bdee5 --- src/ngircd/pam.h +++ 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__ */ blob - 205dbb8dfb83d0a01e67cb194b4a0ea5d0a1924d blob + ef42be1456b0ce5099799213963a029e7881d5af --- src/ngircd/parse.h +++ 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 */ blob - 614aef4c39a741044c745ac4c5e7232f1a54d2bf blob + aace8053c00c2cca27f2a24ed0490f1271137f0e --- src/ngircd/proc.c +++ 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 blob - 57612f172d5e61e2339ea703758a0283b5b9be7c blob + bb4bceb2083c6cb55e4c754c752b225c821d9b48 --- src/ngircd/proc.h +++ 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 */ blob - 5839c19498cde0d8b9939d449bc947537eb678cf blob + ce1bf0d5ba45fefd80eb6900792c60100ea97816 --- src/ngircd/resolve.c +++ 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 blob - 044ceec1e123ba096f66e6b8935fb28d0b52f535 blob + c0b734b8e58cb6426343e9ffdc4b595802cf4245 --- src/ngircd/resolve.h +++ 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, blob - 98f91e8f4d561f3e0f88013f29a379e77bcfcbad blob + 87c693aacc5f068f2fde874b6d0480dd15c6d46d --- src/ngircd/sighandlers.h +++ 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)); blob - 0cb2d20068f5912e203e7a43d5010d7a661c2c3d blob + db6fb7eef24de8e6c08bff50c07ef535c2791552 --- src/portab/exp.h +++ 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 blob - cc51d892a517faab9bd4f9c88d145c5165ab60e5 blob + 2c26e57da2d50f68bf7c470766ae60b07eddc870 --- src/portab/imp.h +++ 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 blob - d2f769f14d77fc590b4a05ba22a60164e96d3956 blob + cb00dfafc057f0798268a2a91efcc37d4eb84db0 --- src/portab/portab.h +++ 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" blob - 0a2098ede6896571540c34b05bf9705c32855aca blob + 2675409abe61780b26313da652ac1bfac97a9a36 --- src/portab/portabtest.c +++ 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 blob - 2f606a022993655414fc7098f26e06d4187a9ac5 blob + 74dd120f4ec5d1b899563c4e7d839af0b0f9488f --- src/portab/splint.h +++ 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 "/" blob - e735157043084d633e84ff7a9b578bca4e832a12 blob + 7c0ee8fd26d34b5746267f0da0f7d73cd9216101 --- src/portab/strdup.c +++ 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 ) { blob - ee93d1d6fcfba52a31b550d4e633edfd63ca3e42 blob + ae2018bcf940a3c47a1cc265740c58fbff70dce8 --- src/portab/strlcpy.c +++ 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 blob - 852c8f705548d557785dc68a86bb0378e3d4e1d4 blob + 043898e9e13f72c6013d6a0f26c7390ed4b4735c --- src/portab/strtok_r.c +++ 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) { blob - 3f9707b7a65affa657477c75aa8e132db7fe5d82 blob + 081152e123b7f62fda95ad9fbb11e9606f26744d --- src/portab/vsnprintf.c +++ 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 blob - 0c169601df3fedebca97461cd04c6a2c0ba9ffdd blob + 5846bd8fcac853db99958f4aee9a4406b3b09f46 --- src/portab/waitpid.c +++ 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; blob - dbdb49a2d9904d97d1fe7369c95b56780ac6da8d blob + ef3fb5d73467355782698aa0b5c78ac44b50bad1 --- src/tool/tool.c +++ 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 blob - 4513a2323fa39c04e56ce419f29fc24e846aa7ae blob + ba52f66bb8bc2ff68087ee9c6a51c3a47f08cfe8 --- src/tool/tool.h +++ 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