Committer : entrope
CVSROOT : /cvsroot/undernet-ircu
Module : ircu2.10
Commit time: 2004-10-05 04:21:47 UTC
Modified files:
ircd/userload.c ircd/uping.c ircd/s_numeric.c ircd/s_misc.c
ircd/s_err.c ircd/s_debug.c ircd/s_auth.c ircd/msgq.c
ircd/ircd_snprintf.c ircd/ircd_md5.c include/whocmds.h
include/userload.h include/uping.h include/send.h
include/s_user.h include/s_stats.h include/s_serv.h
include/s_numeric.h include/s_misc.h include/s_debug.h
include/s_conf.h include/s_bsd.h include/s_auth.h include/parse.h
include/packet.h include/opercmds.h include/numeric.h
include/msgq.h include/msg.h include/match.h
include/ircd_snprintf.h include/ircd_signal.h
include/ircd_reslib.h include/ircd_relay.h
include/ircd_crypt_smd5.h include/ircd_crypt_plain.h
include/ircd_crypt_native.h include/ircd_crypt.h
include/ircd_auth.h include/hash.h include/handlers.h
include/destruct_event.h include/crule.h include/channel.h
include/IPcheck.h
Log message:
Add file-level doxygen comment blocks where they were missing.
---------------------- diff included ----------------------
Index: ircu2.10/include/IPcheck.h
diff -u ircu2.10/include/IPcheck.h:1.11 ircu2.10/include/IPcheck.h:1.12
--- ircu2.10/include/IPcheck.h:1.11 Wed Aug 18 21:00:47 2004
+++ ircu2.10/include/IPcheck.h Mon Oct 4 21:21:37 2004
@@ -1,7 +1,6 @@
-/*
- * IPcheck.h
- *
- * $Id: IPcheck.h,v 1.11 2004/08/19 04:00:47 entrope Exp $
+/** @file IPcheck.h
+ * @brief Interface to count users connected from particular IP addresses.
+ * @version $Id: IPcheck.h,v 1.12 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_ipcheck_h
#define INCLUDED_ipcheck_h
Index: ircu2.10/include/channel.h
diff -u ircu2.10/include/channel.h:1.41 ircu2.10/include/channel.h:1.42
--- ircu2.10/include/channel.h:1.41 Wed Sep 22 03:29:41 2004
+++ ircu2.10/include/channel.h Mon Oct 4 21:21:37 2004
@@ -16,8 +16,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: channel.h,v 1.41 2004/09/22 10:29:41 isomer Exp $
+ */
+/** @file
+ * @brief Channel management and maintenance.
+ * @version $Id: channel.h,v 1.42 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_channel_h
#define INCLUDED_channel_h
Index: ircu2.10/include/crule.h
diff -u ircu2.10/include/crule.h:1.3 ircu2.10/include/crule.h:1.4
--- ircu2.10/include/crule.h:1.3 Fri Sep 15 22:35:01 2000
+++ ircu2.10/include/crule.h Mon Oct 4 21:21:37 2004
@@ -1,7 +1,6 @@
-/*
- * crule.h
- *
- * $Id: crule.h,v 1.3 2000/09/16 05:35:01 bleep Exp $
+/** @file crule.h
+ * @brief Interfaces and declarations for connection rule checking.
+ * @version $Id: crule.h,v 1.4 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_crule_h
#define INCLUDED_crule_h
Index: ircu2.10/include/destruct_event.h
diff -u ircu2.10/include/destruct_event.h:1.1 ircu2.10/include/destruct_event.h:1.2
--- ircu2.10/include/destruct_event.h:1.1 Wed Mar 6 18:07:59 2002
+++ ircu2.10/include/destruct_event.h Mon Oct 4 21:21:37 2004
@@ -17,8 +17,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: destruct_event.h,v 1.1 2002/03/07 02:07:59 isomer Exp $
+ */
+/** @file
+ * @brief Functions for handling timed channel destruction events.
+ * @version $Id: destruct_event.h,v 1.2 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_config_h
Index: ircu2.10/include/handlers.h
diff -u ircu2.10/include/handlers.h:1.19 ircu2.10/include/handlers.h:1.20
--- ircu2.10/include/handlers.h:1.19 Sun May 9 20:08:16 2004
+++ ircu2.10/include/handlers.h Mon Oct 4 21:21:37 2004
@@ -16,13 +16,16 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: handlers.h,v 1.19 2004/05/10 03:08:16 entrope Exp $
+ */
+/** @file
+ * @brief Declarations for all protocol message handler functions.
+ * @version $Id: handlers.h,v 1.20 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_handlers_h
#define INCLUDED_handlers_h
-/*
+/** @page m_functions Protocol Message Handlers
+ *
* m_functions execute protocol messages on this server:
* int m_func(struct Client* cptr, struct Client* sptr, int parc, char* parv[]);
*
@@ -83,7 +86,6 @@
struct Client;
-
extern int m_admin(struct Client*, struct Client*, int, char*[]);
extern int m_away(struct Client*, struct Client*, int, char*[]);
extern int m_cnotice(struct Client*, struct Client*, int, char*[]);
Index: ircu2.10/include/hash.h
diff -u ircu2.10/include/hash.h:1.4 ircu2.10/include/hash.h:1.5
--- ircu2.10/include/hash.h:1.4 Mon Oct 4 20:34:44 2004
+++ ircu2.10/include/hash.h Mon Oct 4 21:21:37 2004
@@ -15,8 +15,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: hash.h,v 1.4 2004/10/05 03:34:44 entrope Exp $
+ */
+/** @file
+ * @brief Hash table management APIs.
+ * @version $Id: hash.h,v 1.5 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_hash_h
Index: ircu2.10/include/ircd_auth.h
diff -u ircu2.10/include/ircd_auth.h:1.1 ircu2.10/include/ircd_auth.h:1.2
--- ircu2.10/include/ircd_auth.h:1.1 Wed Jun 30 15:59:09 2004
+++ ircu2.10/include/ircd_auth.h Mon Oct 4 21:21:37 2004
@@ -19,8 +19,10 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
* 02111-1307, USA.
- *
- * $Id: ircd_auth.h,v 1.1 2004/06/30 22:59:09 entrope Exp $
+ */
+/** @file
+ * @brief Interface to IAuth client implementation.
+ * @version $Id: ircd_auth.h,v 1.2 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_config_h
Index: ircu2.10/include/ircd_crypt.h
diff -u ircu2.10/include/ircd_crypt.h:1.1 ircu2.10/include/ircd_crypt.h:1.2
--- ircu2.10/include/ircd_crypt.h:1.1 Mon Jun 14 18:20:36 2004
+++ ircu2.10/include/ircd_crypt.h Mon Oct 4 21:21:37 2004
@@ -15,8 +15,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: ircd_crypt.h,v 1.1 2004/06/15 01:20:36 entrope Exp $
+ */
+/** @file
+ * @brief Core password encryption and hashing APIs.
+ * @version $Id: ircd_crypt.h,v 1.2 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_ircd_crypt_h
#define INCLUDED_ircd_crypt_h
Index: ircu2.10/include/ircd_crypt_native.h
diff -u ircu2.10/include/ircd_crypt_native.h:1.1
ircu2.10/include/ircd_crypt_native.h:1.2
--- ircu2.10/include/ircd_crypt_native.h:1.1 Mon Jun 14 18:20:36 2004
+++ ircu2.10/include/ircd_crypt_native.h Mon Oct 4 21:21:37 2004
@@ -1,5 +1,6 @@
-/*
- * $Id: ircd_crypt_native.h,v 1.1 2004/06/15 01:20:36 entrope Exp $
+/** @file
+ * @brief Native crypt() function declarations.
+ * @version $Id: ircd_crypt_native.h,v 1.2 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_ircd_crypt_native_h
#define INCLUDED_ircd_crypt_native_h
Index: ircu2.10/include/ircd_crypt_plain.h
diff -u ircu2.10/include/ircd_crypt_plain.h:1.1 ircu2.10/include/ircd_crypt_plain.h:1.2
--- ircu2.10/include/ircd_crypt_plain.h:1.1 Mon Jun 14 18:20:36 2004
+++ ircu2.10/include/ircd_crypt_plain.h Mon Oct 4 21:21:37 2004
@@ -15,8 +15,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: ircd_crypt_plain.h,v 1.1 2004/06/15 01:20:36 entrope Exp $
+ */
+/** @file
+ * @brief Declarations for plaintext password "crypting".
+ * @version $Id: ircd_crypt_plain.h,v 1.2 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_ircd_crypt_plain_h
#define INCLUDED_ircd_crypt_plain_h
Index: ircu2.10/include/ircd_crypt_smd5.h
diff -u ircu2.10/include/ircd_crypt_smd5.h:1.1 ircu2.10/include/ircd_crypt_smd5.h:1.2
--- ircu2.10/include/ircd_crypt_smd5.h:1.1 Mon Jun 14 18:20:36 2004
+++ ircu2.10/include/ircd_crypt_smd5.h Mon Oct 4 21:21:37 2004
@@ -15,8 +15,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: ircd_crypt_smd5.h,v 1.1 2004/06/15 01:20:36 entrope Exp $
+ */
+/** @file
+ * @brief Declarations for salted MD5 password crypting.
+ * @version $Id: ircd_crypt_smd5.h,v 1.2 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_ircd_crypt_smd5_h
#define INCLUDED_ircd_crypt_smd5_h
Index: ircu2.10/include/ircd_relay.h
diff -u ircu2.10/include/ircd_relay.h:1.1 ircu2.10/include/ircd_relay.h:1.2
--- ircu2.10/include/ircd_relay.h:1.1 Fri Mar 17 21:20:28 2000
+++ ircu2.10/include/ircd_relay.h Mon Oct 4 21:21:37 2004
@@ -21,8 +21,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: ircd_relay.h,v 1.1 2000/03/18 05:20:28 bleep Exp $
+ */
+/** @file
+ * @brief Interface to functions for relaying messages.
+ * @version $Id: ircd_relay.h,v 1.2 2004/10/05 04:21:37 entrope Exp $
*/
struct Client;
Index: ircu2.10/include/ircd_reslib.h
diff -u ircu2.10/include/ircd_reslib.h:1.3 ircu2.10/include/ircd_reslib.h:1.4
--- ircu2.10/include/ircd_reslib.h:1.3 Mon Sep 27 20:15:37 2004
+++ ircu2.10/include/ircd_reslib.h Mon Oct 4 21:21:37 2004
@@ -1,8 +1,10 @@
/*
* include/ircd_reslib.h
* (C)opyright 1992 Darren Reed.
- *
- * $Id: ircd_reslib.h,v 1.3 2004/09/28 03:15:37 entrope Exp $
+ */
+/** @file
+ * @brief Interface from ircd resolver to its support functions.
+ * @version $Id: ircd_reslib.h,v 1.4 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_ircdreslib_h
#define INCLUDED_ircdreslib_h
Index: ircu2.10/include/ircd_signal.h
diff -u ircu2.10/include/ircd_signal.h:1.1 ircu2.10/include/ircd_signal.h:1.2
--- ircu2.10/include/ircd_signal.h:1.1 Fri Mar 17 21:20:28 2000
+++ ircu2.10/include/ircd_signal.h Mon Oct 4 21:21:37 2004
@@ -1,7 +1,6 @@
-/*
- * ircd_signal.h
- *
- * $Id: ircd_signal.h,v 1.1 2000/03/18 05:20:28 bleep Exp $
+/** @file ircd_signal.h
+ * @brief Interface to signal handler subsystem.
+ * @version $Id: ircd_signal.h,v 1.2 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_ircd_signal_h
#define INCLUDED_ircd_signal_h
Index: ircu2.10/include/ircd_snprintf.h
diff -u ircu2.10/include/ircd_snprintf.h:1.7 ircu2.10/include/ircd_snprintf.h:1.8
--- ircu2.10/include/ircd_snprintf.h:1.7 Mon Sep 27 18:14:19 2004
+++ ircu2.10/include/ircd_snprintf.h Mon Oct 4 21:21:37 2004
@@ -17,8 +17,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: ircd_snprintf.h,v 1.7 2004/09/28 01:14:19 entrope Exp $
+ */
+/** @file
+ * @brief IRC-specific printf() clone interface.
+ * @version $Id: ircd_snprintf.h,v 1.8 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_sys_types_h
#include <sys/types.h>
Index: ircu2.10/include/match.h
diff -u ircu2.10/include/match.h:1.5 ircu2.10/include/match.h:1.6
--- ircu2.10/include/match.h:1.5 Tue Sep 28 07:58:40 2004
+++ ircu2.10/include/match.h Mon Oct 4 21:21:37 2004
@@ -1,9 +1,6 @@
-/*
- * match.h
- */
-/* @file
+/** @file match.h
* @brief Interface for matching strings to IRC masks.
- * @version $Id: match.h,v 1.5 2004/09/28 14:58:40 entrope Exp $
+ * @version $Id: match.h,v 1.6 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_match_h
#define INCLUDED_match_h
Index: ircu2.10/include/msg.h
diff -u ircu2.10/include/msg.h:1.15 ircu2.10/include/msg.h:1.16
--- ircu2.10/include/msg.h:1.15 Mon Oct 4 19:50:40 2004
+++ ircu2.10/include/msg.h Mon Oct 4 21:21:37 2004
@@ -16,8 +16,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: msg.h,v 1.15 2004/10/05 02:50:40 entrope Exp $
+ */
+/** @file
+ * @brief Command and token declarations and structures.
+ * @version $Id: msg.h,v 1.16 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_msg_h
#define INCLUDED_msg_h
Index: ircu2.10/include/msgq.h
diff -u ircu2.10/include/msgq.h:1.7 ircu2.10/include/msgq.h:1.8
--- ircu2.10/include/msgq.h:1.7 Wed Sep 29 20:55:43 2004
+++ ircu2.10/include/msgq.h Mon Oct 4 21:21:37 2004
@@ -17,8 +17,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: msgq.h,v 1.7 2004/09/30 03:55:43 entrope Exp $
+ */
+/** @file
+ * @brief Outbound message queue interface and declarations.
+ * @version $Id: msgq.h,v 1.8 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_ircd_defs_h
#include "ircd_defs.h" /* BUFSIZE */
Index: ircu2.10/include/numeric.h
diff -u ircu2.10/include/numeric.h:1.32 ircu2.10/include/numeric.h:1.33
--- ircu2.10/include/numeric.h:1.32 Wed Sep 22 18:29:03 2004
+++ ircu2.10/include/numeric.h Mon Oct 4 21:21:37 2004
@@ -15,8 +15,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: numeric.h,v 1.32 2004/09/23 01:29:03 entrope Exp $
+ */
+/** @file
+ * @brief Declarations of numeric replies and supporting functions.
+ * @version $Id: numeric.h,v 1.33 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_numeric_h
#define INCLUDED_numeric_h
Index: ircu2.10/include/opercmds.h
diff -u ircu2.10/include/opercmds.h:1.4 ircu2.10/include/opercmds.h:1.5
--- ircu2.10/include/opercmds.h:1.4 Tue Jan 7 02:06:43 2003
+++ ircu2.10/include/opercmds.h Mon Oct 4 21:21:37 2004
@@ -1,7 +1,6 @@
-/*
- * opercmds.h
- *
- * $Id: opercmds.h,v 1.4 2003/01/07 10:06:43 a1kmm Exp $
+/** @file opercmds.h
+ * @brief Declarations of AsLL ping helper commands.
+ * @version $Id: opercmds.h,v 1.5 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_opercmds_h
#define INCLUDED_opercmds_h
Index: ircu2.10/include/packet.h
diff -u ircu2.10/include/packet.h:1.7 ircu2.10/include/packet.h:1.8
--- ircu2.10/include/packet.h:1.7 Thu Jul 4 19:09:19 2002
+++ ircu2.10/include/packet.h Mon Oct 4 21:21:37 2004
@@ -1,7 +1,6 @@
-/*
- * packet.h
- *
- * $Id: packet.h,v 1.7 2002/07/05 02:09:19 a1kmm Exp $
+/** @file packet.h
+ * @brief Declarations for packet handling functions.
+ * @version $Id: packet.h,v 1.8 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_packet_h
#define INCLUDED_packet_h
Index: ircu2.10/include/parse.h
diff -u ircu2.10/include/parse.h:1.3 ircu2.10/include/parse.h:1.4
--- ircu2.10/include/parse.h:1.3 Sun May 9 20:08:15 2004
+++ ircu2.10/include/parse.h Mon Oct 4 21:21:37 2004
@@ -1,7 +1,6 @@
-/*
- * parse.h
- *
- * $Id: parse.h,v 1.3 2004/05/10 03:08:15 entrope Exp $
+/** @file parse.h
+ * @brief Declarations for parsing input from users and other servers.
+ * @version $Id: parse.h,v 1.4 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_parse_h
#define INCLUDED_parse_h
Index: ircu2.10/include/s_auth.h
diff -u ircu2.10/include/s_auth.h:1.5 ircu2.10/include/s_auth.h:1.6
--- ircu2.10/include/s_auth.h:1.5 Tue Sep 21 08:22:53 2004
+++ ircu2.10/include/s_auth.h Mon Oct 4 21:21:37 2004
@@ -14,8 +14,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: s_auth.h,v 1.5 2004/09/21 15:22:53 entrope Exp $
+ */
+/** @file
+ * @brief Interface for DNS and ident lookups.
+ * @version $Id: s_auth.h,v 1.6 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_s_auth_h
#define INCLUDED_s_auth_h
Index: ircu2.10/include/s_bsd.h
diff -u ircu2.10/include/s_bsd.h:1.18 ircu2.10/include/s_bsd.h:1.19
--- ircu2.10/include/s_bsd.h:1.18 Tue Sep 21 12:18:50 2004
+++ ircu2.10/include/s_bsd.h Mon Oct 4 21:21:37 2004
@@ -1,7 +1,6 @@
-/*
- * s_bsd.h
- *
- * $Id: s_bsd.h,v 1.18 2004/09/21 19:18:50 entrope Exp $
+/** @file s_bsd.h
+ * @brief Wrapper functions to avoid direct use of BSD APIs.
+ * @version $Id: s_bsd.h,v 1.19 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_s_bsd_h
#define INCLUDED_s_bsd_h
@@ -26,7 +25,9 @@
* set client to a smaller size to allow TCP flow control
* to reduce flooding
*/
+/** Default TCP window size for server connections. */
#define SERVER_TCP_WINDOW 61440
+/** Default TCP window size for client connections. */
#define CLIENT_TCP_WINDOW 2048
extern void report_error(const char* text, const char* who, int err);
Index: ircu2.10/include/s_conf.h
diff -u ircu2.10/include/s_conf.h:1.26 ircu2.10/include/s_conf.h:1.27
--- ircu2.10/include/s_conf.h:1.26 Wed Sep 29 19:42:17 2004
+++ ircu2.10/include/s_conf.h Mon Oct 4 21:21:37 2004
@@ -1,7 +1,6 @@
-/*
- * s_conf.h
- *
- * $Id: s_conf.h,v 1.26 2004/09/30 02:42:17 entrope Exp $
+/** @file s_conf.h
+ * @brief ircd configuration file API.
+ * @version $Id: s_conf.h,v 1.27 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_s_conf_h
#define INCLUDED_s_conf_h
Index: ircu2.10/include/s_debug.h
diff -u ircu2.10/include/s_debug.h:1.11 ircu2.10/include/s_debug.h:1.12
--- ircu2.10/include/s_debug.h:1.11 Wed Sep 22 17:36:55 2004
+++ ircu2.10/include/s_debug.h Mon Oct 4 21:21:37 2004
@@ -1,7 +1,6 @@
-/*
- * s_debug.h
- *
- * $Id: s_debug.h,v 1.11 2004/09/23 00:36:55 entrope Exp $
+/* @file s_debug.h
+ * @brief Debug APIs for the ircd.
+ * @version $Id: s_debug.h,v 1.12 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_s_debug_h
#define INCLUDED_s_debug_h
Index: ircu2.10/include/s_misc.h
diff -u ircu2.10/include/s_misc.h:1.7 ircu2.10/include/s_misc.h:1.8
--- ircu2.10/include/s_misc.h:1.7 Wed Sep 22 19:01:47 2004
+++ ircu2.10/include/s_misc.h Mon Oct 4 21:21:37 2004
@@ -1,7 +1,6 @@
-/*
- * s_misc.h
- *
- * $Id: s_misc.h,v 1.7 2004/09/23 02:01:47 entrope Exp $
+/** @file s_misc.h
+ * @brief Miscellaneous support functions and declarations.
+ * @version $Id: s_misc.h,v 1.8 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_s_misc_h
#define INCLUDED_s_misc_h
Index: ircu2.10/include/s_numeric.h
diff -u ircu2.10/include/s_numeric.h:1.2 ircu2.10/include/s_numeric.h:1.3
--- ircu2.10/include/s_numeric.h:1.2 Fri Mar 17 21:20:28 2000
+++ ircu2.10/include/s_numeric.h Mon Oct 4 21:21:37 2004
@@ -1,7 +1,6 @@
-/*
- * s_numeric.h
- *
- * $Id: s_numeric.h,v 1.2 2000/03/18 05:20:28 bleep Exp $
+/** @file s_numeric.h
+ * @brief Send a numeric message to a client.
+ * @version $Id: s_numeric.h,v 1.3 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_s_numeric_h
#define INCLUDED_s_numeric_h
Index: ircu2.10/include/s_serv.h
diff -u ircu2.10/include/s_serv.h:1.6 ircu2.10/include/s_serv.h:1.7
--- ircu2.10/include/s_serv.h:1.6 Fri Jun 8 16:12:16 2001
+++ ircu2.10/include/s_serv.h Mon Oct 4 21:21:37 2004
@@ -1,7 +1,6 @@
-/*
- * s_serv.h
- *
- * $Id: s_serv.h,v 1.6 2001/06/08 23:12:16 kev Exp $
+/** @file s_serv.h
+ * @brief Miscellaneous server support functions.
+ * @version $Id: s_serv.h,v 1.7 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_s_serv_h
#define INCLUDED_s_serv_h
Index: ircu2.10/include/s_stats.h
diff -u ircu2.10/include/s_stats.h:1.11 ircu2.10/include/s_stats.h:1.12
--- ircu2.10/include/s_stats.h:1.11 Wed Sep 29 19:42:17 2004
+++ ircu2.10/include/s_stats.h Mon Oct 4 21:21:37 2004
@@ -18,8 +18,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: s_stats.h,v 1.11 2004/09/30 02:42:17 entrope Exp $
+ */
+/** @file
+ * @brief Report configuration lines and other statistics from this server.
+ * @version $Id: s_stats.h,v 1.12 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_s_stats_h
Index: ircu2.10/include/s_user.h
diff -u ircu2.10/include/s_user.h:1.18 ircu2.10/include/s_user.h:1.19
--- ircu2.10/include/s_user.h:1.18 Mon Sep 27 05:32:17 2004
+++ ircu2.10/include/s_user.h Mon Oct 4 21:21:37 2004
@@ -1,7 +1,6 @@
-/*
- * s_user.h
- *
- * $Id: s_user.h,v 1.18 2004/09/27 12:32:17 entrope Exp $
+/** @file s_user.h
+ * @brief Miscellaneous user-related helper functions.
+ * @version $Id: s_user.h,v 1.19 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_s_user_h
#define INCLUDED_s_user_h
Index: ircu2.10/include/send.h
diff -u ircu2.10/include/send.h:1.20 ircu2.10/include/send.h:1.21
--- ircu2.10/include/send.h:1.20 Mon Sep 27 05:32:18 2004
+++ ircu2.10/include/send.h Mon Oct 4 21:21:37 2004
@@ -1,7 +1,6 @@
-/*
- * send.h
- *
- * $Id: send.h,v 1.20 2004/09/27 12:32:18 entrope Exp $
+/** @file send.h
+ * @brief Send messages to certain targets.
+ * @version $Id: send.h,v 1.21 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_send_h
#define INCLUDED_send_h
Index: ircu2.10/include/uping.h
diff -u ircu2.10/include/uping.h:1.7 ircu2.10/include/uping.h:1.8
--- ircu2.10/include/uping.h:1.7 Mon Sep 27 10:39:53 2004
+++ ircu2.10/include/uping.h Mon Oct 4 21:21:37 2004
@@ -15,8 +15,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: uping.h,v 1.7 2004/09/27 17:39:53 entrope Exp $
+ */
+/** @file
+ * @brief UDP ping implementation.
+ * @version $Id: uping.h,v 1.8 2004/10/05 04:21:37 entrope Exp $
*/
#ifndef INCLUDED_uping_h
#define INCLUDED_uping_h
Index: ircu2.10/include/userload.h
diff -u ircu2.10/include/userload.h:1.5 ircu2.10/include/userload.h:1.6
--- ircu2.10/include/userload.h:1.5 Mon Sep 27 14:24:41 2004
+++ ircu2.10/include/userload.h Mon Oct 4 21:21:36 2004
@@ -19,8 +19,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: userload.h,v 1.5 2004/09/27 21:24:41 entrope Exp $
+ */
+/** @file
+ * @brief Userload tracking and statistics.
+ * @version $Id: userload.h,v 1.6 2004/10/05 04:21:36 entrope Exp $
*/
#ifndef INCLUDED_userload_h
#define INCLUDED_userload_h
Index: ircu2.10/include/whocmds.h
diff -u ircu2.10/include/whocmds.h:1.8 ircu2.10/include/whocmds.h:1.9
--- ircu2.10/include/whocmds.h:1.8 Mon Sep 27 14:48:07 2004
+++ ircu2.10/include/whocmds.h Mon Oct 4 21:21:36 2004
@@ -1,7 +1,6 @@
-/*
- * whocmds.h
- *
- * $Id: whocmds.h,v 1.8 2004/09/27 21:48:07 entrope Exp $
+/** @file whocmds.h
+ * @brief Support functions for /WHO-like commands.
+ * @version $Id: whocmds.h,v 1.9 2004/10/05 04:21:36 entrope Exp $
*/
#ifndef INCLUDED_whocmds_h
#define INCLUDED_whocmds_h
Index: ircu2.10/ircd/ircd_md5.c
diff -u ircu2.10/ircd/ircd_md5.c:1.2 ircu2.10/ircd/ircd_md5.c:1.3
--- ircu2.10/ircd/ircd_md5.c:1.2 Mon Oct 4 19:32:22 2004
+++ ircu2.10/ircd/ircd_md5.c Mon Oct 4 21:21:36 2004
@@ -17,9 +17,11 @@
* will fill a supplied 16-byte array with the digest.
*
* ircuified 2002 by hikari
- *
- * $Id: ircd_md5.c,v 1.2 2004/10/05 02:32:22 entrope Exp $
-*/
+ */
+/** @file
+ * @brief MD5 implementation for ircu.
+ * @version $Id: ircd_md5.c,v 1.3 2004/10/05 04:21:36 entrope Exp $
+ */
#include <string.h>
#include "ircd_md5.h"
Index: ircu2.10/ircd/ircd_snprintf.c
diff -u ircu2.10/ircd/ircd_snprintf.c:1.15 ircu2.10/ircd/ircd_snprintf.c:1.16
--- ircu2.10/ircd/ircd_snprintf.c:1.15 Mon Sep 27 18:14:18 2004
+++ ircu2.10/ircd/ircd_snprintf.c Mon Oct 4 21:21:36 2004
@@ -15,8 +15,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: ircd_snprintf.c,v 1.15 2004/09/28 01:14:18 entrope Exp $
+ */
+/** @file
+ * @brief IRC-specific printf() clone implementation.
+ * @version $Id: ircd_snprintf.c,v 1.16 2004/10/05 04:21:36 entrope Exp $
*/
#include "config.h"
Index: ircu2.10/ircd/msgq.c
diff -u ircu2.10/ircd/msgq.c:1.8 ircu2.10/ircd/msgq.c:1.9
--- ircu2.10/ircd/msgq.c:1.8 Wed Sep 29 20:55:43 2004
+++ ircu2.10/ircd/msgq.c Mon Oct 4 21:21:36 2004
@@ -15,8 +15,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: msgq.c,v 1.8 2004/09/30 03:55:43 entrope Exp $
+ */
+/** @file
+ * @brief Outbound message queue implementation.
+ * @version $Id: msgq.c,v 1.9 2004/10/05 04:21:36 entrope Exp $
*/
#include "config.h"
Index: ircu2.10/ircd/s_auth.c
diff -u ircu2.10/ircd/s_auth.c:1.30 ircu2.10/ircd/s_auth.c:1.31
--- ircu2.10/ircd/s_auth.c:1.30 Tue Sep 21 08:54:43 2004
+++ ircu2.10/ircd/s_auth.c Mon Oct 4 21:21:36 2004
@@ -16,8 +16,6 @@
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*
- * $Id: s_auth.c,v 1.30 2004/09/21 15:54:43 entrope Exp $
- *
* Changes:
* July 6, 1999 - Rewrote most of the code here. When a client connects
* to the server and passes initial socket validation checks, it
@@ -27,6 +25,10 @@
* any messages from it.
* --Bleep Thomas Helvey <[EMAIL PROTECTED]>
*/
+/** @file
+ * @brief Implementation of DNS and ident lookups.
+ * @version $Id: s_auth.c,v 1.31 2004/10/05 04:21:36 entrope Exp $
+ */
#include "config.h"
#include "s_auth.h"
Index: ircu2.10/ircd/s_debug.c
diff -u ircu2.10/ircd/s_debug.c:1.32 ircu2.10/ircd/s_debug.c:1.33
--- ircu2.10/ircd/s_debug.c:1.32 Wed Sep 22 17:36:56 2004
+++ ircu2.10/ircd/s_debug.c Mon Oct 4 21:21:36 2004
@@ -16,9 +16,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: s_debug.c,v 1.32 2004/09/23 00:36:56 entrope Exp $
- *
+ */
+/** @file
+ * @brief Debug support for the ircd.
+ * @version $Id: s_debug.c,v 1.33 2004/10/05 04:21:36 entrope Exp $
*/
#include "config.h"
Index: ircu2.10/ircd/s_err.c
diff -u ircu2.10/ircd/s_err.c:1.55 ircu2.10/ircd/s_err.c:1.56
--- ircu2.10/ircd/s_err.c:1.55 Mon Sep 27 06:20:23 2004
+++ ircu2.10/ircd/s_err.c Mon Oct 4 21:21:36 2004
@@ -15,8 +15,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: s_err.c,v 1.55 2004/09/27 13:20:23 entrope Exp $
+ */
+/** @file
+ * @brief Error handling support.
+ * @version $Id: s_err.c,v 1.56 2004/10/05 04:21:36 entrope Exp $
*/
#include "config.h"
Index: ircu2.10/ircd/s_misc.c
diff -u ircu2.10/ircd/s_misc.c:1.40 ircu2.10/ircd/s_misc.c:1.41
--- ircu2.10/ircd/s_misc.c:1.40 Mon Sep 27 06:20:23 2004
+++ ircu2.10/ircd/s_misc.c Mon Oct 4 21:21:36 2004
@@ -19,8 +19,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: s_misc.c,v 1.40 2004/09/27 13:20:23 entrope Exp $
+ */
+/** @file
+ * @brief Miscellaneous support functions.
+ * @version $Id: s_misc.c,v 1.41 2004/10/05 04:21:36 entrope Exp $
*/
#include "config.h"
Index: ircu2.10/ircd/s_numeric.c
diff -u ircu2.10/ircd/s_numeric.c:1.9 ircu2.10/ircd/s_numeric.c:1.10
--- ircu2.10/ircd/s_numeric.c:1.9 Wed Sep 22 19:07:42 2004
+++ ircu2.10/ircd/s_numeric.c Mon Oct 4 21:21:36 2004
@@ -17,8 +17,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: s_numeric.c,v 1.9 2004/09/23 02:07:42 entrope Exp $
+ */
+/** @file
+ * @brief Send a numeric message to a client.
+ * @version $Id: s_numeric.c,v 1.10 2004/10/05 04:21:36 entrope Exp $
*/
#include "config.h"
Index: ircu2.10/ircd/uping.c
diff -u ircu2.10/ircd/uping.c:1.18 ircu2.10/ircd/uping.c:1.19
--- ircu2.10/ircd/uping.c:1.18 Mon Sep 27 10:39:53 2004
+++ ircu2.10/ircd/uping.c Mon Oct 4 21:21:36 2004
@@ -15,8 +15,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: uping.c,v 1.18 2004/09/27 17:39:53 entrope Exp $
+ */
+/** @file
+ * @brief UDP ping implementation.
+ * @version $Id: uping.c,v 1.19 2004/10/05 04:21:36 entrope Exp $
*/
#include "config.h"
Index: ircu2.10/ircd/userload.c
diff -u ircu2.10/ircd/userload.c:1.10 ircu2.10/ircd/userload.c:1.11
--- ircu2.10/ircd/userload.c:1.10 Mon Sep 27 14:24:41 2004
+++ ircu2.10/ircd/userload.c Mon Oct 4 21:21:36 2004
@@ -1,7 +1,7 @@
/*
* Userload module by Michael L. VanLoon (mlv) <[EMAIL PROTECTED]>
* Written 2/93. Originally grafted into irc2.7.2g 4/93.
- *
+ *
* Rewritten 9/97 by Carlo Wood (Run) <[EMAIL PROTECTED]>
* because previous version used ridiculous amounts of memory
* (stored all loads of the passed three days ~ 8 megs).
@@ -22,8 +22,10 @@
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- *
- * $Id: userload.c,v 1.10 2004/09/27 21:24:41 entrope Exp $
+ */
+/** @file
+ * @brief Userload tracking and statistics.
+ * @version $Id: userload.c,v 1.11 2004/10/05 04:21:36 entrope Exp $
*/
#include "config.h"
----------------------- End of diff -----------------------
