From 5246a6127cca4385da318f2e75271b4f5907947b Mon Sep 17 00:00:00 2001 From: Michael Poole Date: Tue, 5 Oct 2004 04:21:37 +0000 Subject: [PATCH] Add file-level doxygen comment blocks where they were missing. git-svn-id: file:///home/klmitch/undernet-ircu/undernet-ircu-svn/ircu2/trunk@1231 c9e4aea6-c8fd-4c43-8297-357d70d61c8c --- include/IPcheck.h | 7 +++---- include/channel.h | 6 ++++-- include/crule.h | 7 +++---- include/destruct_event.h | 6 ++++-- include/handlers.h | 10 ++++++---- include/hash.h | 6 ++++-- include/ircd_auth.h | 6 ++++-- include/ircd_crypt.h | 6 ++++-- include/ircd_crypt_native.h | 5 +++-- include/ircd_crypt_plain.h | 6 ++++-- include/ircd_crypt_smd5.h | 6 ++++-- include/ircd_relay.h | 6 ++++-- include/ircd_reslib.h | 6 ++++-- include/ircd_signal.h | 7 +++---- include/ircd_snprintf.h | 6 ++++-- include/match.h | 5 +---- include/msg.h | 6 ++++-- include/msgq.h | 6 ++++-- include/numeric.h | 6 ++++-- include/opercmds.h | 7 +++---- include/packet.h | 7 +++---- include/parse.h | 7 +++---- include/s_auth.h | 6 ++++-- include/s_bsd.h | 9 +++++---- include/s_conf.h | 7 +++---- include/s_debug.h | 7 +++---- include/s_misc.h | 7 +++---- include/s_numeric.h | 7 +++---- include/s_serv.h | 7 +++---- include/s_stats.h | 6 ++++-- include/s_user.h | 7 +++---- include/send.h | 7 +++---- include/uping.h | 6 ++++-- include/userload.h | 6 ++++-- include/whocmds.h | 7 +++---- ircd/ircd_md5.c | 8 +++++--- ircd/ircd_snprintf.c | 6 ++++-- ircd/msgq.c | 6 ++++-- ircd/s_auth.c | 6 ++++-- ircd/s_debug.c | 7 ++++--- ircd/s_err.c | 6 ++++-- ircd/s_misc.c | 6 ++++-- ircd/s_numeric.c | 6 ++++-- ircd/uping.c | 6 ++++-- ircd/userload.c | 8 +++++--- 45 files changed, 167 insertions(+), 127 deletions(-) diff --git a/include/IPcheck.h b/include/IPcheck.h index c5eb32d..19e9cfb 100644 --- a/include/IPcheck.h +++ b/include/IPcheck.h @@ -1,7 +1,6 @@ -/* - * IPcheck.h - * - * $Id$ +/** @file IPcheck.h + * @brief Interface to count users connected from particular IP addresses. + * @version $Id$ */ #ifndef INCLUDED_ipcheck_h #define INCLUDED_ipcheck_h diff --git a/include/channel.h b/include/channel.h index 51236ca..e0dc902 100644 --- a/include/channel.h +++ b/include/channel.h @@ -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$ + */ +/** @file + * @brief Channel management and maintenance. + * @version $Id$ */ #ifndef INCLUDED_channel_h #define INCLUDED_channel_h diff --git a/include/crule.h b/include/crule.h index ccea385..a89fd54 100644 --- a/include/crule.h +++ b/include/crule.h @@ -1,7 +1,6 @@ -/* - * crule.h - * - * $Id$ +/** @file crule.h + * @brief Interfaces and declarations for connection rule checking. + * @version $Id$ */ #ifndef INCLUDED_crule_h #define INCLUDED_crule_h diff --git a/include/destruct_event.h b/include/destruct_event.h index 6c5d524..5b3b3ca 100644 --- a/include/destruct_event.h +++ b/include/destruct_event.h @@ -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$ + */ +/** @file + * @brief Functions for handling timed channel destruction events. + * @version $Id$ */ #ifndef INCLUDED_config_h diff --git a/include/handlers.h b/include/handlers.h index ca72913..2fad18c 100644 --- a/include/handlers.h +++ b/include/handlers.h @@ -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$ + */ +/** @file + * @brief Declarations for all protocol message handler functions. + * @version $Id$ */ #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*[]); diff --git a/include/hash.h b/include/hash.h index 0280619..67af00b 100644 --- a/include/hash.h +++ b/include/hash.h @@ -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$ + */ +/** @file + * @brief Hash table management APIs. + * @version $Id$ */ #ifndef INCLUDED_hash_h diff --git a/include/ircd_auth.h b/include/ircd_auth.h index 61e27f1..9d36764 100644 --- a/include/ircd_auth.h +++ b/include/ircd_auth.h @@ -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$ + */ +/** @file + * @brief Interface to IAuth client implementation. + * @version $Id$ */ #ifndef INCLUDED_config_h diff --git a/include/ircd_crypt.h b/include/ircd_crypt.h index f4c2fb6..0e69a45 100644 --- a/include/ircd_crypt.h +++ b/include/ircd_crypt.h @@ -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$ + */ +/** @file + * @brief Core password encryption and hashing APIs. + * @version $Id$ */ #ifndef INCLUDED_ircd_crypt_h #define INCLUDED_ircd_crypt_h diff --git a/include/ircd_crypt_native.h b/include/ircd_crypt_native.h index 8001b78..57a851e 100644 --- a/include/ircd_crypt_native.h +++ b/include/ircd_crypt_native.h @@ -1,5 +1,6 @@ -/* - * $Id$ +/** @file + * @brief Native crypt() function declarations. + * @version $Id$ */ #ifndef INCLUDED_ircd_crypt_native_h #define INCLUDED_ircd_crypt_native_h diff --git a/include/ircd_crypt_plain.h b/include/ircd_crypt_plain.h index 6b9d580..99d99d7 100644 --- a/include/ircd_crypt_plain.h +++ b/include/ircd_crypt_plain.h @@ -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$ + */ +/** @file + * @brief Declarations for plaintext password "crypting". + * @version $Id$ */ #ifndef INCLUDED_ircd_crypt_plain_h #define INCLUDED_ircd_crypt_plain_h diff --git a/include/ircd_crypt_smd5.h b/include/ircd_crypt_smd5.h index 9680f12..2414519 100644 --- a/include/ircd_crypt_smd5.h +++ b/include/ircd_crypt_smd5.h @@ -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$ + */ +/** @file + * @brief Declarations for salted MD5 password crypting. + * @version $Id$ */ #ifndef INCLUDED_ircd_crypt_smd5_h #define INCLUDED_ircd_crypt_smd5_h diff --git a/include/ircd_relay.h b/include/ircd_relay.h index b34c864..49acd48 100644 --- a/include/ircd_relay.h +++ b/include/ircd_relay.h @@ -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$ + */ +/** @file + * @brief Interface to functions for relaying messages. + * @version $Id$ */ struct Client; diff --git a/include/ircd_reslib.h b/include/ircd_reslib.h index fc8920b..fae4156 100644 --- a/include/ircd_reslib.h +++ b/include/ircd_reslib.h @@ -1,8 +1,10 @@ /* * include/ircd_reslib.h * (C)opyright 1992 Darren Reed. - * - * $Id$ + */ +/** @file + * @brief Interface from ircd resolver to its support functions. + * @version $Id$ */ #ifndef INCLUDED_ircdreslib_h #define INCLUDED_ircdreslib_h diff --git a/include/ircd_signal.h b/include/ircd_signal.h index fc214fd..0b42653 100644 --- a/include/ircd_signal.h +++ b/include/ircd_signal.h @@ -1,7 +1,6 @@ -/* - * ircd_signal.h - * - * $Id$ +/** @file ircd_signal.h + * @brief Interface to signal handler subsystem. + * @version $Id$ */ #ifndef INCLUDED_ircd_signal_h #define INCLUDED_ircd_signal_h diff --git a/include/ircd_snprintf.h b/include/ircd_snprintf.h index d4d0ccf..23fa826 100644 --- a/include/ircd_snprintf.h +++ b/include/ircd_snprintf.h @@ -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$ + */ +/** @file + * @brief IRC-specific printf() clone interface. + * @version $Id$ */ #ifndef INCLUDED_sys_types_h #include diff --git a/include/match.h b/include/match.h index 4a3b771..4af6747 100644 --- a/include/match.h +++ b/include/match.h @@ -1,7 +1,4 @@ -/* - * match.h - */ -/* @file +/** @file match.h * @brief Interface for matching strings to IRC masks. * @version $Id$ */ diff --git a/include/msg.h b/include/msg.h index 372935a..92d9f17 100644 --- a/include/msg.h +++ b/include/msg.h @@ -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$ + */ +/** @file + * @brief Command and token declarations and structures. + * @version $Id$ */ #ifndef INCLUDED_msg_h #define INCLUDED_msg_h diff --git a/include/msgq.h b/include/msgq.h index a52aaf9..409daab 100644 --- a/include/msgq.h +++ b/include/msgq.h @@ -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$ + */ +/** @file + * @brief Outbound message queue interface and declarations. + * @version $Id$ */ #ifndef INCLUDED_ircd_defs_h #include "ircd_defs.h" /* BUFSIZE */ diff --git a/include/numeric.h b/include/numeric.h index 989a07d..263ff82 100644 --- a/include/numeric.h +++ b/include/numeric.h @@ -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$ + */ +/** @file + * @brief Declarations of numeric replies and supporting functions. + * @version $Id$ */ #ifndef INCLUDED_numeric_h #define INCLUDED_numeric_h diff --git a/include/opercmds.h b/include/opercmds.h index df6a7e4..97d109e 100644 --- a/include/opercmds.h +++ b/include/opercmds.h @@ -1,7 +1,6 @@ -/* - * opercmds.h - * - * $Id$ +/** @file opercmds.h + * @brief Declarations of AsLL ping helper commands. + * @version $Id$ */ #ifndef INCLUDED_opercmds_h #define INCLUDED_opercmds_h diff --git a/include/packet.h b/include/packet.h index e0c2a4b..aed4502 100644 --- a/include/packet.h +++ b/include/packet.h @@ -1,7 +1,6 @@ -/* - * packet.h - * - * $Id$ +/** @file packet.h + * @brief Declarations for packet handling functions. + * @version $Id$ */ #ifndef INCLUDED_packet_h #define INCLUDED_packet_h diff --git a/include/parse.h b/include/parse.h index 75e3b0c..6ee62a8 100644 --- a/include/parse.h +++ b/include/parse.h @@ -1,7 +1,6 @@ -/* - * parse.h - * - * $Id$ +/** @file parse.h + * @brief Declarations for parsing input from users and other servers. + * @version $Id$ */ #ifndef INCLUDED_parse_h #define INCLUDED_parse_h diff --git a/include/s_auth.h b/include/s_auth.h index 58cecc5..2925339 100644 --- a/include/s_auth.h +++ b/include/s_auth.h @@ -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$ + */ +/** @file + * @brief Interface for DNS and ident lookups. + * @version $Id$ */ #ifndef INCLUDED_s_auth_h #define INCLUDED_s_auth_h diff --git a/include/s_bsd.h b/include/s_bsd.h index fbef2bf..c4c1387 100644 --- a/include/s_bsd.h +++ b/include/s_bsd.h @@ -1,7 +1,6 @@ -/* - * s_bsd.h - * - * $Id$ +/** @file s_bsd.h + * @brief Wrapper functions to avoid direct use of BSD APIs. + * @version $Id$ */ #ifndef INCLUDED_s_bsd_h #define INCLUDED_s_bsd_h @@ -26,7 +25,9 @@ struct irc_in_addr; * 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); diff --git a/include/s_conf.h b/include/s_conf.h index c02ae97..3d48e8c 100644 --- a/include/s_conf.h +++ b/include/s_conf.h @@ -1,7 +1,6 @@ -/* - * s_conf.h - * - * $Id$ +/** @file s_conf.h + * @brief ircd configuration file API. + * @version $Id$ */ #ifndef INCLUDED_s_conf_h #define INCLUDED_s_conf_h diff --git a/include/s_debug.h b/include/s_debug.h index 3359b10..5bdf57e 100644 --- a/include/s_debug.h +++ b/include/s_debug.h @@ -1,7 +1,6 @@ -/* - * s_debug.h - * - * $Id$ +/* @file s_debug.h + * @brief Debug APIs for the ircd. + * @version $Id$ */ #ifndef INCLUDED_s_debug_h #define INCLUDED_s_debug_h diff --git a/include/s_misc.h b/include/s_misc.h index 90a9eb8..dbf61c2 100644 --- a/include/s_misc.h +++ b/include/s_misc.h @@ -1,7 +1,6 @@ -/* - * s_misc.h - * - * $Id$ +/** @file s_misc.h + * @brief Miscellaneous support functions and declarations. + * @version $Id$ */ #ifndef INCLUDED_s_misc_h #define INCLUDED_s_misc_h diff --git a/include/s_numeric.h b/include/s_numeric.h index 355b0c7..6a9c1de 100644 --- a/include/s_numeric.h +++ b/include/s_numeric.h @@ -1,7 +1,6 @@ -/* - * s_numeric.h - * - * $Id$ +/** @file s_numeric.h + * @brief Send a numeric message to a client. + * @version $Id$ */ #ifndef INCLUDED_s_numeric_h #define INCLUDED_s_numeric_h diff --git a/include/s_serv.h b/include/s_serv.h index e6c1f33..4d6706b 100644 --- a/include/s_serv.h +++ b/include/s_serv.h @@ -1,7 +1,6 @@ -/* - * s_serv.h - * - * $Id$ +/** @file s_serv.h + * @brief Miscellaneous server support functions. + * @version $Id$ */ #ifndef INCLUDED_s_serv_h #define INCLUDED_s_serv_h diff --git a/include/s_stats.h b/include/s_stats.h index 9bc3825..8408d9a 100644 --- a/include/s_stats.h +++ b/include/s_stats.h @@ -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$ + */ +/** @file + * @brief Report configuration lines and other statistics from this server. + * @version $Id$ */ #ifndef INCLUDED_s_stats_h diff --git a/include/s_user.h b/include/s_user.h index d3ed866..80cae35 100644 --- a/include/s_user.h +++ b/include/s_user.h @@ -1,7 +1,6 @@ -/* - * s_user.h - * - * $Id$ +/** @file s_user.h + * @brief Miscellaneous user-related helper functions. + * @version $Id$ */ #ifndef INCLUDED_s_user_h #define INCLUDED_s_user_h diff --git a/include/send.h b/include/send.h index 18fb694..b43733a 100644 --- a/include/send.h +++ b/include/send.h @@ -1,7 +1,6 @@ -/* - * send.h - * - * $Id$ +/** @file send.h + * @brief Send messages to certain targets. + * @version $Id$ */ #ifndef INCLUDED_send_h #define INCLUDED_send_h diff --git a/include/uping.h b/include/uping.h index fe7ae8f..2f92d95 100644 --- a/include/uping.h +++ b/include/uping.h @@ -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$ + */ +/** @file + * @brief UDP ping implementation. + * @version $Id$ */ #ifndef INCLUDED_uping_h #define INCLUDED_uping_h diff --git a/include/userload.h b/include/userload.h index 4268c9a..3891ca8 100644 --- a/include/userload.h +++ b/include/userload.h @@ -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$ + */ +/** @file + * @brief Userload tracking and statistics. + * @version $Id$ */ #ifndef INCLUDED_userload_h #define INCLUDED_userload_h diff --git a/include/whocmds.h b/include/whocmds.h index 0229600..70b89c2 100644 --- a/include/whocmds.h +++ b/include/whocmds.h @@ -1,7 +1,6 @@ -/* - * whocmds.h - * - * $Id$ +/** @file whocmds.h + * @brief Support functions for /WHO-like commands. + * @version $Id$ */ #ifndef INCLUDED_whocmds_h #define INCLUDED_whocmds_h diff --git a/ircd/ircd_md5.c b/ircd/ircd_md5.c index a450c3a..1dc912e 100644 --- a/ircd/ircd_md5.c +++ b/ircd/ircd_md5.c @@ -17,9 +17,11 @@ * will fill a supplied 16-byte array with the digest. * * ircuified 2002 by hikari - * - * $Id$ -*/ + */ +/** @file + * @brief MD5 implementation for ircu. + * @version $Id$ + */ #include #include "ircd_md5.h" diff --git a/ircd/ircd_snprintf.c b/ircd/ircd_snprintf.c index 5945afa..91a9f08 100644 --- a/ircd/ircd_snprintf.c +++ b/ircd/ircd_snprintf.c @@ -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$ + */ +/** @file + * @brief IRC-specific printf() clone implementation. + * @version $Id$ */ #include "config.h" diff --git a/ircd/msgq.c b/ircd/msgq.c index e4692e7..2eeda99 100644 --- a/ircd/msgq.c +++ b/ircd/msgq.c @@ -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$ + */ +/** @file + * @brief Outbound message queue implementation. + * @version $Id$ */ #include "config.h" diff --git a/ircd/s_auth.c b/ircd/s_auth.c index 06731b9..5baa898 100644 --- a/ircd/s_auth.c +++ b/ircd/s_auth.c @@ -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$ - * * 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 */ +/** @file + * @brief Implementation of DNS and ident lookups. + * @version $Id$ + */ #include "config.h" #include "s_auth.h" diff --git a/ircd/s_debug.c b/ircd/s_debug.c index 1232d2d..adab64f 100644 --- a/ircd/s_debug.c +++ b/ircd/s_debug.c @@ -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$ - * + */ +/** @file + * @brief Debug support for the ircd. + * @version $Id$ */ #include "config.h" diff --git a/ircd/s_err.c b/ircd/s_err.c index 980c282..23137fd 100644 --- a/ircd/s_err.c +++ b/ircd/s_err.c @@ -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$ + */ +/** @file + * @brief Error handling support. + * @version $Id$ */ #include "config.h" diff --git a/ircd/s_misc.c b/ircd/s_misc.c index 1371be9..82855b0 100644 --- a/ircd/s_misc.c +++ b/ircd/s_misc.c @@ -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$ + */ +/** @file + * @brief Miscellaneous support functions. + * @version $Id$ */ #include "config.h" diff --git a/ircd/s_numeric.c b/ircd/s_numeric.c index f42e01c..ead7f11 100644 --- a/ircd/s_numeric.c +++ b/ircd/s_numeric.c @@ -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$ + */ +/** @file + * @brief Send a numeric message to a client. + * @version $Id$ */ #include "config.h" diff --git a/ircd/uping.c b/ircd/uping.c index ee47821..3342c8a 100644 --- a/ircd/uping.c +++ b/ircd/uping.c @@ -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$ + */ +/** @file + * @brief UDP ping implementation. + * @version $Id$ */ #include "config.h" diff --git a/ircd/userload.c b/ircd/userload.c index b53fbf4..6bc641b 100644 --- a/ircd/userload.c +++ b/ircd/userload.c @@ -1,7 +1,7 @@ /* * Userload module by Michael L. VanLoon (mlv) * Written 2/93. Originally grafted into irc2.7.2g 4/93. - * + * * Rewritten 9/97 by Carlo Wood (Run) * 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$ + */ +/** @file + * @brief Userload tracking and statistics. + * @version $Id$ */ #include "config.h" -- 2.20.1