Add Doxygen @file documentation to each source and header file

This commit is contained in:
Alexander Barton 2010-12-27 17:14:14 +01:00
parent 408cefd15d
commit 03628dbeaf
71 changed files with 356 additions and 194 deletions

View File

@ -1,11 +1,14 @@
/*
* Functions for AF_ agnostic ipv4/ipv6 handling.
*
* (c) 2008 Florian Westphal <fw@strlen.de>, public domain.
*/
#include "portab.h"
/**
* @file
* Functions for AF_ agnostic ipv4/ipv6 handling.
*/
#include <assert.h>
#include <stdio.h>
#include <string.h>

View File

@ -1,6 +1,4 @@
/*
* Functions for AF_ agnostic ipv4/ipv6 handling.
*
* (c) 2008 Florian Westphal <fw@strlen.de>, public domain.
*/
@ -8,6 +6,11 @@
#define NG_IPADDR_HDR
#include "portab.h"
/**
* @file
* Functions for AF_ agnostic ipv4/ipv6 handling (header).
*/
#include <assert.h>
#include <sys/socket.h>
#include <netinet/in.h>

View File

@ -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"

View File

@ -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 {

View File

@ -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 <assert.h>
#include <stdlib.h>

View File

@ -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)

View File

@ -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 <assert.h>
#include <unistd.h>

View File

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

View File

@ -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 <openssl/ssl.h>

View File

@ -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 <assert.h>
#include <errno.h>

View File

@ -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 <time.h>
#include "defines.h"

View File

@ -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 <assert.h>
#include <string.h>

View File

@ -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

View File

@ -1,11 +1,15 @@
/*
* ngIRCd -- The Next Generation IRC Daemon
*
* SSL wrapper functions.
* Copyright (c) 2005-2008 Florian Westphal <fw@strlen.de>
*/
#include "portab.h"
/**
* @file
* SSL wrapper functions
*/
#include "imp.h"
#include "conf-ssl.h"

View File

@ -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"

View File

@ -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

View File

@ -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 ));

View File

@ -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 <assert.h>
#ifdef PROTOTYPES

View File

@ -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 <time.h> /* for time_t, see below */

View File

@ -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 <assert.h>

View File

@ -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

View File

@ -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 <assert.h>
#include <stdlib.h>

View File

@ -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 <sys/time.h>

View File

@ -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 <assert.h>
#include <stdlib.h>

View File

@ -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 ));

View File

@ -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 <assert.h>
#include <errno.h>

View File

@ -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 ));

View File

@ -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 <assert.h>
#include <stdio.h>

View File

@ -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));

View File

@ -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 <assert.h>
#include <stdio.h>

View File

@ -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 ));

View File

@ -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 <assert.h>
#include <string.h>

View File

@ -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 <assert.h>
#include <stdio.h>

View File

@ -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 ));

View File

@ -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 <assert.h>
#include <stdio.h>

View File

@ -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 ));

View File

@ -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 <assert.h>
#ifdef PROTOTYPES

View File

@ -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, ...));

View File

@ -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 <assert.h>

View File

@ -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));

View File

@ -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 <assert.h>

View File

@ -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"

View File

@ -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 <assert.h>
#include <errno.h>

View File

@ -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 <syslog.h>

View File

@ -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 <assert.h>

View File

@ -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 ));

View File

@ -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)"

View File

@ -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 <assert.h>
#include <stdio.h>

View File

@ -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));

View File

@ -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 <assert.h>
#include <string.h>

View File

@ -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));

View File

@ -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 <assert.h>

View File

@ -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__ */

View File

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

View File

@ -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 <assert.h>
#include <errno.h>

View File

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

View File

@ -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 <assert.h>
#include <errno.h>

View File

@ -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,

View File

@ -11,6 +11,11 @@
#ifndef signals_included_
#define signals_included_
/**
* @file
* Signal Handlers (header).
*/
#include "portab.h"
bool Signals_Init PARAMS((void));

View File

@ -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

View File

@ -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

View File

@ -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"

View File

@ -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 <stdarg.h>

View File

@ -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 "/"

View File

@ -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 <string.h>
#include <stdlib.h>
@ -15,8 +18,6 @@
#include "exp.h"
#ifndef HAVE_STRDUP
GLOBAL char *
strdup( const char *s )
{

View File

@ -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 <http://www.openbsd.org/papers/strlcpy-paper.ps> for details.
*
* Code partially borrowed from compat.c of rsync, written by Andrew
@ -16,11 +22,6 @@
* <http://cvs.samba.org/cgi-bin/cvsweb/rsync/lib/compat.c>
*/
#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 <string.h>
#include <sys/types.h>

View File

@ -1,8 +1,18 @@
/*
* ngIRCd -- The Next Generation IRC Daemon
*/
#include "portab.h"
#include <string.h>
/**
* @file
* Implementation of strtok_r()
*/
#ifndef HAVE_STRTOK_R
#include <string.h>
char *
strtok_r(char *str, const char *delim, char **saveptr)
{

View File

@ -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

View File

@ -1,13 +1,17 @@
/*
* ngIRCd -- The Next Generation IRC Daemon
*
* waitpid() implementation. Public domain.
* Written by Steven D. Blackford for the NeXT system.
*
*/
#include "portab.h"
/**
* @file
* waitpid() implementation. Public domain.
* Written by Steven D. Blackford for the NeXT system.
*/
#ifndef HAVE_WAITPID
#include "imp.h"
#include <string.h>
#include <stdlib.h>
@ -15,8 +19,6 @@
#include "exp.h"
#ifndef HAVE_WAITPID
GLOBAL int
waitpid(pid, stat_loc, options)
int pid, *stat_loc, options;

View File

@ -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 <assert.h>
#include <ctype.h>

View File

@ -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