From 740b09e2aee345c6fde199986d8eab6e0db224e3 Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 16 May 2004 14:58:40 +0000 Subject: Updated header comments git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@816 e03df62e-2008-0410-955e-edbf42e46eb7 --- include/base.h | 18 +++++++++++--- include/channels.h | 19 +++++++++++---- include/commands.h | 16 +++++++++++++ include/connection.h | 18 +++++++++++--- include/ctables.h | 3 ++- include/dynamic.h | 64 +++++++++++++------------------------------------ include/globals.h | 20 ++++++++++++---- include/inspircd.h | 20 ++++++++++++---- include/inspircd_io.h | 2 +- include/inspircd_util.h | 16 +++++++++++-- include/message.h | 16 +++++++++++++ include/mode.h | 16 +++++++++++++ include/modules.h | 20 ++++++++++++---- include/servers.h | 19 +++++++++++---- include/users.h | 19 +++++++++++---- include/wildcard.h | 16 +++++++++++++ include/xline.h | 16 +++++++++++++ 17 files changed, 234 insertions(+), 84 deletions(-) (limited to 'include') diff --git a/include/base.h b/include/base.h index 9b9795229..c959cf869 100644 --- a/include/base.h +++ b/include/base.h @@ -1,6 +1,18 @@ -/* -Defines the base classes used by InspIRCd -*/ +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ #ifndef __BASE_H__ #define __BASE_H__ diff --git a/include/channels.h b/include/channels.h index c0df69513..633d7edef 100644 --- a/include/channels.h +++ b/include/channels.h @@ -1,7 +1,18 @@ -/* - - -*/ +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ #include "inspircd_config.h" #include "base.h" diff --git a/include/commands.h b/include/commands.h index cb339377c..f1c383e08 100644 --- a/include/commands.h +++ b/include/commands.h @@ -1,3 +1,19 @@ +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ + #ifndef __COMMANDS_H #define __COMMANDS_H diff --git a/include/connection.h b/include/connection.h index ee723764c..e146c73bf 100644 --- a/include/connection.h +++ b/include/connection.h @@ -1,6 +1,18 @@ -/* - -*/ +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ #include "inspircd_config.h" #include "base.h" diff --git a/include/ctables.h b/include/ctables.h index 2a1be7b77..fb96b9ef6 100644 --- a/include/ctables.h +++ b/include/ctables.h @@ -2,7 +2,7 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * Inspire is copyright (C) 2002-2003 ChatSpike-Dev. + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. * E-mail: * * @@ -13,6 +13,7 @@ * * --------------------------------------------------- */ + #ifndef __CTABLES_H__ #define __CTABLES_H__ diff --git a/include/dynamic.h b/include/dynamic.h index 0382324ce..987f5de72 100644 --- a/include/dynamic.h +++ b/include/dynamic.h @@ -1,16 +1,23 @@ +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ + + #ifndef __DLL_H #define __DLL_H -// -// class DLLManager is the simple ELF C++ Library manager. -// -// It tries to dynamically load the specified shared library -// when it is construted. -// -// You should call LastError() before doing anything. If it -// returns NULL there is no error. -// - class DLLManager { @@ -32,24 +39,6 @@ class DLLManager }; -// -// class DLLFactoryBase is the base class used for the DLLFactory -// template class. -// -// It inherits from the DLLManager class and must be constructed with -// the file name of the shared library and the function name within that -// library which will create the desired C++ factory class. -// If you do not provide func_name to the constructor, it defaults to -// the undecorated "C" symbol "factory0" -// -// factory_func will be set to a pointer to the requested factory creator -// function. If there was an error linking to the shared library, -// factory_func will be 0. -// -// You can call 'LastError()' to find the error message that occurred. -// -// - class DLLFactoryBase : public DLLManager { public: @@ -59,25 +48,6 @@ class DLLFactoryBase : public DLLManager }; -// -// The DLLFactory template class inherits from DLLFactoryBase. -// The constructor takes the file name of the shared library -// and the undecorated "C" symbol name of the factory creator -// function. The factory creator function in your shared library -// MUST either return a pointer to an object that is a subclass -// of 'T' or it must return 0. -// -// If everything is cool, then 'factory' will point to the -// requested factory class. If not, it will be 0. -// -// Since the DLLFactory template ultimately inherits DLLManager, -// you can call LastError() to get any error code information -// -// The created factory is OWNED by the DLLFactory class. -// The created factory will get deleted when the DLLFactory class -// is deleted, because the DLL will get unloaded as well. -// - template class DLLFactory : public DLLFactoryBase { public: diff --git a/include/globals.h b/include/globals.h index 4087ab00c..146ffb582 100644 --- a/include/globals.h +++ b/include/globals.h @@ -1,8 +1,18 @@ -/* - - -*/ - +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ #ifndef __WORLD_H #define __WORLD_H diff --git a/include/inspircd.h b/include/inspircd.h index 09e286cdc..d55ccccf4 100644 --- a/include/inspircd.h +++ b/include/inspircd.h @@ -1,8 +1,18 @@ -/* - - -*/ - +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ #include #include diff --git a/include/inspircd_io.h b/include/inspircd_io.h index a6403e7ec..28e55bd0b 100644 --- a/include/inspircd_io.h +++ b/include/inspircd_io.h @@ -2,7 +2,7 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * Inspire is copyright (C) 2002-2003 ChatSpike-Dev. + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. * E-mail: * * diff --git a/include/inspircd_util.h b/include/inspircd_util.h index 1a2e59a87..1035960b3 100644 --- a/include/inspircd_util.h +++ b/include/inspircd_util.h @@ -1,5 +1,17 @@ -/* - * InspIRCd utlity functions +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- */ char* SafeStrncpy(char *, const char *, size_t ); diff --git a/include/message.h b/include/message.h index cc9076bce..b8c485f5f 100644 --- a/include/message.h +++ b/include/message.h @@ -1,3 +1,19 @@ +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ + #ifndef __MESSAGE_H #define __MESSAGE_H diff --git a/include/mode.h b/include/mode.h index 8b5f9c638..4e0c8c6d3 100644 --- a/include/mode.h +++ b/include/mode.h @@ -1,3 +1,19 @@ +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ + #ifndef __MODE_H #define __MODE_H diff --git a/include/modules.h b/include/modules.h index 77a75693c..698060681 100644 --- a/include/modules.h +++ b/include/modules.h @@ -1,8 +1,18 @@ -/* - - - -*/ +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ #ifndef __PLUGIN_H diff --git a/include/servers.h b/include/servers.h index af678f5d6..ee4e7290b 100644 --- a/include/servers.h +++ b/include/servers.h @@ -1,7 +1,18 @@ -/* - - -*/ +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ #include "inspircd_config.h" #include "connection.h" diff --git a/include/users.h b/include/users.h index a1739a2a1..7b1e7ccc4 100644 --- a/include/users.h +++ b/include/users.h @@ -1,7 +1,18 @@ -/* - - -*/ +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ #include "inspircd_config.h" #include "channels.h" diff --git a/include/wildcard.h b/include/wildcard.h index fc73c2d2a..63877795d 100644 --- a/include/wildcard.h +++ b/include/wildcard.h @@ -1,3 +1,19 @@ +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ + #include #include "inspircd_config.h" diff --git a/include/xline.h b/include/xline.h index fdd5fb5d1..87f88518f 100644 --- a/include/xline.h +++ b/include/xline.h @@ -1,3 +1,19 @@ +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * Inspire is copyright (C) 2002-2004 ChatSpike-Dev. + * E-mail: + * + * + * + * Written by Craig Edwards, Craig McLure, and others. + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ + #ifndef __XLINE_H #define __XLINE_H -- cgit v1.2.3