February 2011 - ngIRCd GIT Updates

Alexander Barton : Doxygen'ify and update comments in ngircd.{c|h}
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: f3ec90f3f0e3e3b3ccfddda209ac94ba5ad92e42 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=f3ec90f3… Author: Alexander Barton <alex(a)barton.de> Date: Mon Dec 27 17:31:19 2010 +0100 Doxygen'ify and update comments in ngircd.{c|h} --- src/ngircd/ngircd.c | 54 ++++++++++++++++++++++++++++++++++----------------- src/ngircd/ngircd.h | 41 +++++++++++++++++++++++++++++--------- 2 files changed, 67 insertions(+), 28 deletions(-) diff --git a/src/ngircd/ngircd.c b/src/ngircd/ngircd.c index e595caf..4b49ec6 100644 --- a/src/ngircd/ngircd.c +++ b/src/ngircd/ngircd.c @@ -67,11 +67,13 @@ static bool NGIRCd_Init PARAMS(( bool )); /** * The main() function of ngIRCd. + * * Here all starts: this function is called by the operating system loader, * it is the first portion of code executed of ngIRCd. - * @param argc The number of arguments passed to ngIRCd on the command line. - * @param argv An array containing all the arguments passed to ngIRCd. - * @return Global exit code of ngIRCd, zero on success. + * + * @param argc The number of arguments passed to ngIRCd on the command line. + * @param argv An array containing all the arguments passed to ngIRCd. + * @return Global exit code of ngIRCd, zero on success. */ GLOBAL int main( int argc, const char *argv[] ) @@ -232,7 +234,7 @@ main( int argc, const char *argv[] ) } } - /* Debug-Level (for IRCs "VERSION" command) */ + /* Debug level for "VERSION" command */ NGIRCd_DebugLevel[0] = '\0'; #ifdef DEBUG if( NGIRCd_Debug ) strcpy( NGIRCd_DebugLevel, "1" ); @@ -287,11 +289,9 @@ main( int argc, const char *argv[] ) exit(1); } - /* - * create protocol and server identification. - * The syntax used by ngIRCd in PASS commands and the extended flags - * are described in doc/Protocol.txt - */ + /* Create protocol and server identification. The syntax + * used by ngIRCd in PASS commands and the known "extended + * flags" are described in doc/Protocol.txt. */ #ifdef IRCPLUS snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s:%s", PROTOVER, PROTOIRCPLUS, PACKAGE_NAME, PACKAGE_VERSION, IRCPLUSFLAGS ); #ifdef ZLIB @@ -316,11 +316,10 @@ main( int argc, const char *argv[] ) Pidfile_Delete( ); exit( 1 ); } - - /* Hauptschleife */ + + /* Main Run Loop */ Conn_Handler( ); - /* Alles abmelden */ Conn_Exit( ); Client_Exit( ); Channel_Exit( ); @@ -333,10 +332,12 @@ main( int argc, const char *argv[] ) /** - * Generate ngIRCd "version string". - * This string is generated once and then stored in NGIRCd_Version for - * further usage, for example by the IRC command VERSION and the --version - * command line switch. + * Generate ngIRCd "version strings". + * + * The ngIRCd version information is generated once and then stored in the + * NGIRCd_Version and NGIRCd_VersionAddition string variables for further + * usage, for example by the IRC command "VERSION" and the --version command + * line switch. */ static void Fill_Version( void ) @@ -466,7 +467,8 @@ Pidfile_Delete( void ) /** * Create the file containing the process ID of ngIRCd ("PID file"). - * @param pid The process ID to be stored in this file. + * + * @param pid The process ID to be stored in this file. */ static void Pidfile_Create(pid_t pid) @@ -504,6 +506,8 @@ Pidfile_Create(pid_t pid) /** * Redirect stdin, stdout and stderr to apropriate file handles. + * + * @param fd The file handle stdin, stdout and stderr should be redirected to. */ static void Setup_FDStreams(int fd) @@ -519,6 +523,13 @@ Setup_FDStreams(int fd) } /* Setup_FDStreams */ +/** + * Get user and group ID of unprivileged "nobody" user. + * + * @param uid User ID + * @param gid Group ID + * @return true on success. + */ static bool NGIRCd_getNobodyID(uid_t *uid, gid_t *gid ) { @@ -543,7 +554,7 @@ NGIRCd_getNobodyID(uid_t *uid, gid_t *gid ) if ( !pwd->pw_uid || !pwd->pw_gid) return false; - *uid = pwd->pw_uid; + *uid = pwd->pw_uid; *gid = pwd->pw_gid; endpwent(); @@ -551,6 +562,13 @@ NGIRCd_getNobodyID(uid_t *uid, gid_t *gid ) } /* NGIRCd_getNobodyID */ +/** + * Initialize ngIRCd daemon. + * + * @param NGIRCd_NoDaemon Set to true if ngIRCd should run in the + * foreground and not as a daemon. + * @return true on success. + */ static bool NGIRCd_Init( bool NGIRCd_NoDaemon ) { diff --git a/src/ngircd/ngircd.h b/src/ngircd/ngircd.h index 143a9ff..2efb8a9 100644 --- a/src/ngircd/ngircd.h +++ b/src/ngircd/ngircd.h @@ -1,6 +1,6 @@ /* * ngIRCd -- The Next Generation IRC Daemon - * Copyright (c)2001,2002 by Alexander Barton (alex(a)barton.de) + * Copyright (c)2001-2010 Alexander Barton (alex(a)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 @@ -23,31 +23,52 @@ #define C_ARRAY_SIZE(x) (sizeof(x)/sizeof((x)[0])) +/** UNIX timestamp of ngIRCd start */ +GLOBAL time_t NGIRCd_Start; -GLOBAL time_t NGIRCd_Start; /* Startzeitpunkt des Daemon */ +/** ngIRCd start time as string, used for RPL_CREATED_MSG (003) */ GLOBAL char NGIRCd_StartStr[64]; + +/** ngIRCd version number containing release number and compile-time options */ GLOBAL char NGIRCd_Version[126]; + +/** String specifying the compile-time options and target platform */ GLOBAL char NGIRCd_VersionAddition[126]; #ifdef DEBUG -GLOBAL bool NGIRCd_Debug; /* Debug-Modus aktivieren */ +/** Flag indicating if debug mode is active (true) or not (false) */ +GLOBAL bool NGIRCd_Debug; #endif #ifdef SNIFFER -GLOBAL bool NGIRCd_Sniffer; /* Sniffer aktivieren */ +/** Flag indication if sniffer is active (true) or not (false) */ +GLOBAL bool NGIRCd_Sniffer; #endif -GLOBAL bool NGIRCd_Passive; /* nicht zu anderen Servern connecten */ +/** + * Flag indicating if NO outgoing connections should be established (true) + * or not (false, the default) + */ +GLOBAL bool NGIRCd_Passive; -GLOBAL bool NGIRCd_SignalQuit; /* true: quit server*/ -GLOBAL bool NGIRCd_SignalRestart; /* true: restart server */ +/** Flag indicating that ngIRCd has been requested to quit (true) */ +GLOBAL bool NGIRCd_SignalQuit; -GLOBAL char NGIRCd_DebugLevel[2]; /* Debug-Level fuer IRC_VERSION() */ +/** Flag indicating that ngIRCd has been requested to restart (true) */ +GLOBAL bool NGIRCd_SignalRestart; -GLOBAL char NGIRCd_ConfFile[FNAME_LEN]; /* Konfigurationsdatei */ +/** + * Debug level for "VERSION" command, see description of numeric RPL_VERSION + * (351) in RFC 2812. ngIRCd sets debuglevel to 1 when the debug mode is + * active, and to 2 if the sniffer is running. + */ +GLOBAL char NGIRCd_DebugLevel[2]; -GLOBAL char NGIRCd_ProtoID[COMMAND_LEN];/* Protokoll- und Server-Identifikation */ +/** Full path and file name of current configuration file */ +GLOBAL char NGIRCd_ConfFile[FNAME_LEN]; +/** Protocol and server identification string; see doc/Protocol.txt */ +GLOBAL char NGIRCd_ProtoID[COMMAND_LEN]; #endif

1 0

Alexander Barton : Doxygen'ify and update comments in match.c
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: c6a7de869cce97c88d813921304a2c5498273e1e URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=c6a7de86… Author: Alexander Barton <alex(a)barton.de> Date: Mon Dec 27 17:28:30 2010 +0100 Doxygen'ify and update comments in match.c --- src/ngircd/match.c | 33 +++++++++++++++++++++++---------- 1 files changed, 23 insertions(+), 10 deletions(-) diff --git a/src/ngircd/match.c b/src/ngircd/match.c index 162a4f2..79699ea 100644 --- a/src/ngircd/match.c +++ b/src/ngircd/match.c @@ -27,10 +27,9 @@ /* - * Die Pattern-Matching-Funkionen [Matche(), Matche_After_Star()] basieren - * auf Versionen von J. Kercheval. Die Version 1.1 wurde am 12.03.1991 als - * "public domain" freigegeben: - * <http://www.snippets.org/snippets/portable/MATCH+C.php3> + * The pattern matching functions [Matche(), Matche_After_Star()] are based + * on code of J. Kercheval. Version 1.1 has been released on 1991-03-12 as + * "public domain": <http://c.snippets.org/snip_lister.php?fname=match.c> */ @@ -38,14 +37,21 @@ static int Matche PARAMS(( const char *p, const char *t )); static int Matche_After_Star PARAMS(( const char *p, const char *t )); -#define MATCH_PATTERN 6 /* bad pattern */ -#define MATCH_LITERAL 5 /* match failure on literal match */ -#define MATCH_RANGE 4 /* match failure on [..] construct */ -#define MATCH_ABORT 3 /* premature end of text string */ -#define MATCH_END 2 /* premature end of pattern string */ -#define MATCH_VALID 1 /* valid match */ +#define MATCH_PATTERN 6 /**< bad pattern */ +#define MATCH_LITERAL 5 /**< match failure on literal match */ +#define MATCH_RANGE 4 /**< match failure on [..] construct */ +#define MATCH_ABORT 3 /**< premature end of text string */ +#define MATCH_END 2 /**< premature end of pattern string */ +#define MATCH_VALID 1 /**< valid match */ +/** + * Match string with pattern. + * + * @param Pattern Pattern to match with + * @param String Input string + * @return true if pattern matches + */ GLOBAL bool Match( const char *Pattern, const char *String ) { @@ -55,6 +61,13 @@ Match( const char *Pattern, const char *String ) } /* Match */ +/** + * Match string with pattern case-insensitive. + * + * @param pattern Pattern to match with + * @param searchme Input string, at most COMMAND_LEN-1 characters long + * @return true if pattern matches + */ GLOBAL bool MatchCaseInsensitive(const char *pattern, const char *searchme) {

1 0

Alexander Barton : Update and translate comments in hash.c
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: 4ef23df8137557cee0e657d5b05fa09c4c61c6ca URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=4ef23df8… Author: Alexander Barton <alex(a)barton.de> Date: Mon Dec 27 17:27:21 2010 +0100 Update and translate comments in hash.c --- src/ngircd/hash.c | 19 +++++++++++-------- 1 files changed, 11 insertions(+), 8 deletions(-) diff --git a/src/ngircd/hash.c b/src/ngircd/hash.c index eb980d1..113133d 100644 --- a/src/ngircd/hash.c +++ b/src/ngircd/hash.c @@ -26,15 +26,18 @@ #include "exp.h" #include "hash.h" +static UINT32 jenkins_hash PARAMS((register UINT8 *k, register UINT32 length, + register UINT32 initval)); -static UINT32 jenkins_hash PARAMS(( register UINT8 *k, register UINT32 length, register UINT32 initval )); - - +/** + * Calculate hash value for a given string. + * + * @param String Input string + * @return 32 bit hash value + */ GLOBAL UINT32 Hash( const char *String ) { - /* Hash-Wert ueber String berechnen */ - char buffer[LINE_LEN]; strlcpy(buffer, String, sizeof(buffer)); @@ -43,15 +46,15 @@ Hash( const char *String ) } /* Hash */ /* - * Die hier verwendete Hash-Funktion stammt aus lookup2.c von Bob Jenkins - * (URL: <http://burtleburtle.net/bob/c/lookup2.c>). Aus dem Header: + * This hash function originates from lookup2.c of Bob Jenkins + * (URL: <http://burtleburtle.net/bob/c/lookup2.c>): * -------------------------------------------------------------------- * lookup2.c, by Bob Jenkins, December 1996, Public Domain. * hash(), hash2(), hash3, and mix() are externally useful functions. * Routines to test the hash are included if SELF_TEST is defined. * You can use this free for any purpose. It has no warranty. * -------------------------------------------------------------------- - * nicht alle seiner Funktionen werden hier genutzt. + * Not all of his functions are used here. */ #define hashsize(n) ((UINT32)1<<(n))

1 0

Alexander Barton : Doxygen'ify conf.h
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: 5555b6cc8612e08d21750af0cd9dadb1196ff115 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=5555b6cc… Author: Alexander Barton <alex(a)barton.de> Date: Mon Dec 27 17:25:48 2010 +0100 Doxygen'ify conf.h --- src/ngircd/conf.h | 138 ++++++++++++++++++++++++++++++----------------------- 1 files changed, 78 insertions(+), 60 deletions(-) diff --git a/src/ngircd/conf.h b/src/ngircd/conf.h index 7632e2b..8c6aea8 100644 --- a/src/ngircd/conf.h +++ b/src/ngircd/conf.h @@ -27,54 +27,66 @@ #include "proc.h" #include "conf-ssl.h" - +/** + * Configured IRC operator. + * Please note the the name of the IRC operaor and his nick have nothing to + * do with each other! The IRC operator is only identified by the name and + * password configured in this structure. + */ struct Conf_Oper { - char name[CLIENT_PASS_LEN]; /* Name (ID) of IRC operator */ - char pwd[CLIENT_PASS_LEN]; /* Password */ - char *mask; /* allowed host mask */ + char name[CLIENT_PASS_LEN]; /**< Name (ID) */ + char pwd[CLIENT_PASS_LEN]; /**< Password */ + char *mask; /**< Allowed host mask */ }; +/** + * Configured server. + * Peers to which this daemon should establish an outgoing server link must + * have set a port number; all other servers are allowed to connect to this one. + */ typedef struct _Conf_Server { - char host[HOST_LEN]; /* Hostname */ - char name[CLIENT_ID_LEN]; /* IRC-Client-ID */ - char pwd_in[CLIENT_PASS_LEN]; /* Password which must be received */ - char pwd_out[CLIENT_PASS_LEN]; /* Password to send to peer */ - UINT16 port; /* Server port */ - int group; /* Group of server */ - time_t lasttry; /* Last connect attempt */ - PROC_STAT res_stat; /* Status of the resolver */ - int flags; /* Flags */ - CONN_ID conn_id; /* ID of server connection or NONE */ - ng_ipaddr_t bind_addr; /* source address to use for outgoing - connections */ - ng_ipaddr_t dst_addr[2]; /* list of addresses to connect to */ + char host[HOST_LEN]; /**< Hostname */ + char name[CLIENT_ID_LEN]; /**< IRC client ID */ + char pwd_in[CLIENT_PASS_LEN]; /**< Password which must be received */ + char pwd_out[CLIENT_PASS_LEN]; /**< Password to send to the peer */ + UINT16 port; /**< Server port to connect to */ + int group; /**< Group ID of this server */ + time_t lasttry; /**< Time of last connection attempt */ + PROC_STAT res_stat; /**< Status of the resolver */ + int flags; /**< Server flags */ + CONN_ID conn_id; /**< ID of server connection or NONE */ + ng_ipaddr_t bind_addr; /**< Source address to use for outgoing + connections */ + ng_ipaddr_t dst_addr[2]; /**< List of addresses to connect to */ #ifdef SSL_SUPPORT - bool SSLConnect; /* connect() using SSL? */ + bool SSLConnect; /**< Establish connection using SSL? */ #endif - char svs_mask[CLIENT_ID_LEN]; /* Mask of nick names that are - services */ + char svs_mask[CLIENT_ID_LEN]; /**< Mask of nick names that should be + treated and counted as services */ } CONF_SERVER; #ifdef SSL_SUPPORT +/** Configuration options required for SSL support */ struct SSLOptions { - char *KeyFile; - char *CertFile; - char *DHFile; - array ListenPorts; - array KeyFilePassword; + char *KeyFile; /**< SSL key file */ + char *CertFile; /**< SSL certificate file */ + char *DHFile; /**< File containing DH parameters */ + array ListenPorts; /**< Array of listening SSL ports */ + array KeyFilePassword; /**< Key file password */ }; #endif +/** Pre-defined channels */ struct Conf_Channel { - char name[CHANNEL_NAME_LEN]; /* Name of the channel */ - char modes[CHANNEL_MODE_LEN]; /* Initial channel modes */ - char key[CLIENT_PASS_LEN]; /* Channel key ("password", mode "k" ) */ - char topic[COMMAND_LEN]; /* Initial topic */ - char keyfile[512]; /* Path and name of channel key file */ - unsigned long maxusers; /* maximum usercount for this channel, mode "l" */ + char name[CHANNEL_NAME_LEN]; /**< Name of the channel */ + char modes[CHANNEL_MODE_LEN]; /**< Initial channel modes */ + char key[CLIENT_PASS_LEN]; /**< Channel key ("password", mode "k" ) */ + char topic[COMMAND_LEN]; /**< Initial topic */ + char keyfile[512]; /**< Path and name of channel key file */ + unsigned long maxusers; /**< User limit for this channel, mode "l" */ }; @@ -82,76 +94,82 @@ struct Conf_Channel { #define CONF_SFLAG_DISABLED 2 /* This server configuration entry is disabled */ -/* Name ("Nick") of the servers */ +/** Name (ID, "nick") of this server */ GLOBAL char Conf_ServerName[CLIENT_ID_LEN]; -/* Server info text */ +/** Server info text */ GLOBAL char Conf_ServerInfo[CLIENT_INFO_LEN]; -/* Global server passwort */ +/** Global server passwort */ GLOBAL char Conf_ServerPwd[CLIENT_PASS_LEN]; -/* Administrative information */ +/** Administrative information */ GLOBAL char Conf_ServerAdmin1[CLIENT_INFO_LEN]; GLOBAL char Conf_ServerAdmin2[CLIENT_INFO_LEN]; GLOBAL char Conf_ServerAdminMail[CLIENT_INFO_LEN]; -/* Message of the Day */ +/** Message of the day (MOTD) of this server */ GLOBAL array Conf_Motd; -/* Ports the server should listen on */ +/** Array of ports this server should listen on */ GLOBAL array Conf_ListenPorts; -/* Address to which the socket should be bound or empty (=all) */ +/** Address to which sockets should be bound to or empty (=all) */ GLOBAL char *Conf_ListenAddress; -/* User and group ID the server should run with */ +/** User and group ID this daemon should run with */ GLOBAL uid_t Conf_UID; GLOBAL gid_t Conf_GID; -/* A directory to chroot() in */ +/** The directory to chroot() into */ GLOBAL char Conf_Chroot[FNAME_LEN]; -/* File with PID of daemon */ +/** Full path and name of a file to which the PID of daemon should be written */ GLOBAL char Conf_PidFile[FNAME_LEN]; -/* Timeouts for PING and PONG */ +/** Timeout (in seconds) for PING commands */ GLOBAL int Conf_PingTimeout; + +/** Timeout (in seconds) for PONG replies */ GLOBAL int Conf_PongTimeout; -/* Seconds between connect attempts to other servers */ +/** Seconds between connection attempts to other servers */ GLOBAL int Conf_ConnectRetry; -/* Operators */ +/** Array of configured IRC operators */ GLOBAL array Conf_Opers; -/* Servers */ +/** Array of configured IRC servers */ GLOBAL CONF_SERVER Conf_Server[MAX_SERVERS]; -/* Pre-defined channels */ +/** Array of pre-defined channels */ GLOBAL array Conf_Channels; -/* Pre-defined channels only */ +/** Flag indicating if only pre-defined channels are allowed (true) or not */ GLOBAL bool Conf_PredefChannelsOnly; -/* Are IRC operators allowed to always use MODE? */ +/** Flag indicating if IRC operators are allowed to always use MODE (true) */ GLOBAL bool Conf_OperCanMode; -/* If an IRC op gives chanop privileges without being a chanop, - * ircd2 will ignore the command. This enables a workaround: - * It masks the command as coming from the server */ +/** + * If true, mask channel MODE commands of IRC operators to the server. + * Background: ircd2 will ignore channel MODE commands if an IRC operator + * gives chanel operator privileges to someone without being a channel operator + * himself. This enables a workaround: it masks the MODE command as coming + * from the IRC server and not the IRC operator. + */ GLOBAL bool Conf_OperServerMode; -/* Are remote IRC operators allowed to manage this server? */ +/** Flag indicating if remote IRC operators are allowed to manage this server */ GLOBAL bool Conf_AllowRemoteOper; -/* Enable all DNS functions? */ +/** Enable all DNS functions? */ GLOBAL bool Conf_DNS; -/* Enable IDENT lookups, even when compiled with support for it */ +/** Enable IDENT lookups, even when compiled with support for it */ GLOBAL bool Conf_Ident; -/* Enable all usage of PAM, even when compiled with support for it */ +/** Enable all usage of PAM, even when compiled with support for it */ GLOBAL bool Conf_PAM; /* @@ -160,19 +178,19 @@ GLOBAL bool Conf_PAM; */ GLOBAL bool Conf_ConnectIPv6; -/* same as above, but for ipv4 hosts, default: yes */ +/** Try to connect to remote systems using the IPv4 protocol (true) */ GLOBAL bool Conf_ConnectIPv4; -/* Maximum number of connections to this server */ +/** Maximum number of simultaneous connections to this server */ GLOBAL long Conf_MaxConnections; -/* Maximum number of channels a user can join */ +/** Maximum number of channels a user can join */ GLOBAL int Conf_MaxJoins; -/* Maximum number of connections per IP address */ +/** Maximum number of connections per IP address */ GLOBAL int Conf_MaxConnectionsIP; -/* Maximum length of a nick name */ +/** Maximum length of a nick name */ GLOBAL unsigned int Conf_MaxNickLength; #ifdef SYSLOG

1 0

Alexander Barton : Add missong Doxygen @file tags to ngircd.h and irc-op.h
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: 72a982ae7e436b98102699b4f090d992d0600b44 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=72a982ae… Author: Alexander Barton <alex(a)barton.de> Date: Mon Dec 27 17:23:25 2010 +0100 Add missong Doxygen @file tags to ngircd.h and irc-op.h --- src/ngircd/irc-op.h | 8 ++++---- src/ngircd/ngircd.h | 9 +++++---- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/src/ngircd/irc-op.h b/src/ngircd/irc-op.h index 1b55101..f7ee450 100644 --- a/src/ngircd/irc-op.h +++ b/src/ngircd/irc-op.h @@ -7,15 +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. - * - * $Id: irc-op.h,v 1.4 2005/03/19 18:43:48 fw Exp $ - * - * Channel operator commands (header) */ #ifndef __irc_op_h__ #define __irc_op_h__ +/** + * @file + * Channel operator commands (header) + */ GLOBAL bool IRC_KICK PARAMS(( CLIENT *Client, REQUEST *Req )); GLOBAL bool IRC_INVITE PARAMS(( CLIENT *Client, REQUEST *Req )); diff --git a/src/ngircd/ngircd.h b/src/ngircd/ngircd.h index fb23794..143a9ff 100644 --- a/src/ngircd/ngircd.h +++ b/src/ngircd/ngircd.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: ngircd.h,v 1.22 2005/06/24 19:20:56 fw Exp $ - * - * Prototypes of the "main module". */ #ifndef __ngircd_h__ #define __ngircd_h__ +/** + * @file + * Global variables of ngIRCd. + */ + #include <time.h> #include "defines.h"

1 0

Alexander Barton : Code cleanup: mostly removing empty lines
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

1 0

Alexander Barton : Doxygen: define ZLIB, PAM, and ZEROCONF
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: ebfcdb088be271adfe17303163534956715b85e9 URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=ebfcdb08… Author: Alexander Barton <alex(a)barton.de> Date: Mon Dec 27 17:15:37 2010 +0100 Doxygen: define ZLIB, PAM, and ZEROCONF --- doc/src/Doxyfile | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/doc/src/Doxyfile b/doc/src/Doxyfile index 62a219c..8afec5e 100644 --- a/doc/src/Doxyfile +++ b/doc/src/Doxyfile @@ -159,6 +159,6 @@ GENERATE_PERLMOD = NO # undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = DEBUG CONN_MODULE __client_c__ +PREDEFINED = DEBUG ZLIB PAM ZEROCONF CONN_MODULE __client_c__ # -eof-

1 0

Alexander Barton : Add Doxygen @ file documentation to each source and header file
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

1 0

Alexander Barton : Updated Doxygen configuration file
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: 408cefd15d4540d340283cdfbfad62a8e432cf8e URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=408cefd1… Author: Alexander Barton <alex(a)barton.de> Date: Sun Dec 26 19:32:07 2010 +0100 Updated Doxygen configuration file Removed unnecessary variables DETAILS_AT_TOP, EXTRACT_PRIVATE, EXTRACT_LOCAL_CLASSES, added SHOW_DIRECTORIES=YES, STRIP_CODE_COMMENTS=NO, REFERENCED_BY_RELATION=YES, REFERENCES_RELATION=YES, HTML_DYNAMIC_SECTIONS=YES and GENERATE_DOCSET=NO; updated PREDEFINED. --- doc/src/Doxyfile | 53 ++++++++++++++++++++++++++++++++--------------------- 1 files changed, 32 insertions(+), 21 deletions(-) diff --git a/doc/src/Doxyfile b/doc/src/Doxyfile index 55363e1..62a219c 100644 --- a/doc/src/Doxyfile +++ b/doc/src/Doxyfile @@ -1,6 +1,6 @@ # # ngIRCd -- The Next Generation IRC Daemon -# Copyright (c)2001-2005 Alexander Barton (alex(a)barton.de) +# Copyright (c)2001-2010 Alexander Barton (alex(a)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 @@ -8,11 +8,9 @@ # (at your option) any later version. # Please read the file COPYING, README and AUTHORS for more information. # -# $Id: Doxyfile,v 1.2 2005/07/23 00:48:38 alex Exp $ -# - # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for ngIRCd. +# #--------------------------------------------------------------------------- # Project related configuration options @@ -47,13 +45,6 @@ STRIP_FROM_PATH = ../.. JAVADOC_AUTOBRIEF = YES -# If the DETAILS_AT_TOP tag is set to YES then Doxygen -# will output the detailed description near the top, like JavaDoc. -# If set to NO, the detailed description appears after the member -# documentation. - -DETAILS_AT_TOP = NO - # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # sources only. Doxygen will then generate output that is more tailored for C. # For instance, some of the names that are used will be different. The list @@ -72,21 +63,16 @@ OPTIMIZE_OUTPUT_FOR_C = YES EXTRACT_ALL = YES -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. - -EXTRACT_PRIVATE = YES - # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = YES -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory +# hierarchy in the documentation. The default is NO. -EXTRACT_LOCAL_CLASSES = YES +SHOW_DIRECTORIES = YES #--------------------------------------------------------------------------- # configuration options related to the input files @@ -116,6 +102,22 @@ RECURSIVE = YES SOURCE_BROWSER = YES +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = NO + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES then for each documented +# function all documented entities called/used by that function will be listed. + +REFERENCES_RELATION = YES + #--------------------------------------------------------------------------- # Output formats #--------------------------------------------------------------------------- @@ -128,6 +130,15 @@ GENERATE_HTML = YES HTML_FOOTER = footer.inc.html +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports JavaScript and +# DHTML is required (for instance Mozilla 1.0+, Firefox Netscape 6.0+, +# Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = YES + +GENERATE_DOCSET = NO GENERATE_HTMLHELP = NO GENERATE_LATEX = NO GENERATE_RTF = NO @@ -148,6 +159,6 @@ GENERATE_PERLMOD = NO # undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = CONN_MODULE __client_c__ +PREDEFINED = DEBUG CONN_MODULE __client_c__ # -eof-

1 0

Alexander Barton : Doxygen: remove own header and CSS file
by alex＠arthur.barton.de 13 Feb '11

13 Feb '11

Module: ngircd.git Branch: master Commit: f59f773cfeffeb945c3924f27b4122c9170af31d URL: http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git&a=commit;h=f59f773c… Author: Alexander Barton <alex(a)barton.de> Date: Sun Dec 26 19:27:29 2010 +0100 Doxygen: remove own header and CSS file Use the ones of Doxygen instead, this has the advantage that we benefit of new functionality of Doxygen without having to make changes. --- doc/src/Doxyfile | 8 ++-- doc/src/header.inc.html | 10 ------ doc/src/ngircd-doc.css | 77 ----------------------------------------------- 3 files changed, 4 insertions(+), 91 deletions(-) diff --git a/doc/src/Doxyfile b/doc/src/Doxyfile index 776607b..55363e1 100644 --- a/doc/src/Doxyfile +++ b/doc/src/Doxyfile @@ -122,11 +122,11 @@ SOURCE_BROWSER = YES GENERATE_HTML = YES -HTML_OUTPUT = html -HTML_FILE_EXTENSION = .html -HTML_HEADER = header.inc.html +# The HTML_FOOTER tag can be used to specify a personal HTML footer for each +# generated HTML page. If it is left blank doxygen will generate a standard +# footer. + HTML_FOOTER = footer.inc.html -HTML_STYLESHEET = ngircd-doc.css GENERATE_HTMLHELP = NO GENERATE_LATEX = NO diff --git a/doc/src/header.inc.html b/doc/src/header.inc.html deleted file mode 100644 index 592c016..0000000 --- a/doc/src/header.inc.html +++ /dev/null @@ -1,10 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html lang="en"> - -<head> - <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> - <title>ngIRCd Source Documentation</title> - <link href="ngircd-doc.css" rel="stylesheet" type="text/css"> -</head> -<body> - diff --git a/doc/src/ngircd-doc.css b/doc/src/ngircd-doc.css deleted file mode 100644 index a2453aa..0000000 --- a/doc/src/ngircd-doc.css +++ /dev/null @@ -1,77 +0,0 @@ -/* - * Cascading Style Sheet for the ngIRCd source documentation - * - * $Id: ngircd-doc.css,v 1.2 2005/07/22 21:23:22 alex Exp $ - */ - -BODY { - background-color: white; - color: black; - margin: 30px; - font-family: Geneva, sans-serif; - font-size: 12px; -} - -A:visited { color: purple; background: transparent; } -A:link { color: navy; background: transparent; } -A:active { color: red; background: transparent; } -A:hover { background: #ffa; } - -H1, H2, H3 { - font-family: Verdana, sans-serif; - background-color: white; - color: #005555; -} -H1 { margin-bottom: 10px; } -H2 { - margin-top: 20px; - margin-bottom: 10px; -} - -P, LI, TD, TH, DT { - font-family: Geneva, sans-serif; - font-size: 12px; - line-height: 1.2 -} - -DD { margin-bottom: 1em; } - -UL { list-style-type: square; } - -HR { margin: 2em 0px; } - -BODY>TABLE { padding: 1em 0px; } - -TD.mdRow { - border: 1px dotted silver; - background-color: #fff9dd; -} - -TD.md { font-weight: bold; } - -TD.memItemLeft { padding-top: 4px; } -TD.memItemRight { padding-top: 4px; } -TD.mdescRight { font-style: italic; } - -DIV.qindex { - background-color: #eee; - border: 1px dotted silver; - padding: 3px; - margin-bottom: 2px; -} - -DIV.nav { - margin: 1em 0px; -} - -HR.footer { margin-top: 50px; } - -.comment { - color: gray; - font-style: italic; -} -.preprocessor { color: #f90; } -.keyword, .keywordflow, .keywordtype { color: red; } -.stringliteral { color: green; } - -/* -eof- */

1 0