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

diff --git a/include/IPcheck.h b/include/IPcheck.h
index c5eb32dce32565b6a898ee0abeed45bfc8d4322e..19e9cfb8122d0f103d32c86819b91e40ac454744 100644 (file)
--- 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 51236cafbc77702898920f023172c6d0260a544d..e0dc9021e496801b4f4fcab54cb2cf7fe25be947 100644 (file)
--- 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 ccea385f219fcac194a9b8727476effaff7f30cb..a89fd549a77aa0318d981e8324c3cd60fbc4ad29 100644 (file)
--- 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 6c5d524e9cac2799ea424d0f42a8c7eedfbf87a5..5b3b3ca46f8d8399c354be8a235d1f662fd943b4 100644 (file)
--- 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 ca72913359b2b3a95ae466f4c745c1181e0fa373..2fad18c04e6149d4cf4ada7cbdd04f059184e121 100644 (file)
--- 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 02806192aa7366269135c19632f69e71c0a3a62c..67af00b08d24b027bdf96a45ec5c5628515d47e9 100644 (file)
--- 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 61e27f1af59c744d9920b0460d2835b811b45e02..9d3676472a32dfbf10d4f914dfaf4c677d620673 100644 (file)
--- 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 f4c2fb6e8caede2742205787356237d28460b6ee..0e69a45e77bf5b854be549364d8e5a98928e862b 100644 (file)
--- 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 8001b78b61d46fc485398f0420f0749248d1ab17..57a851e059c4a3dc32bb3154fa830d2b4440e9a7 100644 (file)
--- 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 6b9d5802427e1175ff339237062e832b863a0b30..99d99d71c20a3e6e3b187dec2f1b95a5ce92ae47 100644 (file)
--- 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 9680f122065cf61a1984beb97f9fa1c3e8cb5a98..24145196f650e6cca4f1e1b23135419d55a5b814 100644 (file)
--- 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 b34c864b9a5de4e6966b2bcaa52e6119a6c25b7a..49acd483bac31aa086b5bfb33640c16f5d456b8f 100644 (file)
--- 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 fc8920b81a7e5c4570dc8d38430db5af34bed792..fae4156bf88709bfde44a4c5fa61f94dde89b576 100644 (file)
--- 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 fc214fd5dd43d721677b99ec42cc00b3ed4ad9b9..0b426537df098b2b5e423acd7a22f1df62d1474e 100644 (file)
--- 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 d4d0ccfd53d2fb5affe35fa9e870e592656a552b..23fa826b45b71bf04b84996e4032967ccede1bd1 100644 (file)
--- 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 <sys/types.h>

diff --git a/include/match.h b/include/match.h
index 4a3b771e232012376a1f95c64bd5d780482c0495..4af674794f8100407fb5e6e28fb59e332186893b 100644 (file)
--- 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 372935a1710228c47f654e2a735b15331313b98b..92d9f1700e50d87f8cfd0b859e08b386728d85a7 100644 (file)
--- 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 a52aaf919ca727b450aa4ede235bd12db2720210..409daabcb7e9ded8248e05924a1723afeeb08ede 100644 (file)
--- 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 989a07d58797b2d2a6d13d4cbdb1ae2172c4b70d..263ff827273119ba66cb0885f1812587bb00a383 100644 (file)
--- 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 df6a7e4e565c4ae72d3bc20380d97279edf0597b..97d109ecc997220572b0dc1996d76549fffd8790 100644 (file)
--- 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 e0c2a4bdcd381a6edf7e766cb80eb66de27542fb..aed45023942eca123883e8c90b07ff0945a517de 100644 (file)
--- 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 75e3b0c520e20de5916e967b2760e01a412facf0..6ee62a8d606a7a77d4eb0685d69bbeeb942a31f3 100644 (file)
--- 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 58cecc588f5054b967ae836eaad0d346f7c89acd..2925339e0079bfe679e9db8d960595a8dcfcd2a3 100644 (file)
--- 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 fbef2bf38f7712b67fb7b02c78015127c1ef6c9e..c4c1387e742d35b7ea10719e897d70d81903aef4 100644 (file)
--- 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 c02ae97e18b2ae32ed721537a0e49a25774e1ff0..3d48e8cbc75070466959dba659ef30ada3590edf 100644 (file)
--- 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 3359b10f5b2cc9aa0a1b515e5cc9810c159e379e..5bdf57e8109641d0f952661edbbd57b5f76a98cc 100644 (file)
--- 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 90a9eb83ca44842561649e289be079ccc81ce33a..dbf61c297c91553197b185791c139ff682059886 100644 (file)
--- 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 355b0c7ea39427180c1ccbafd398679097b8f672..6a9c1de409f4c7c34e11cf4e8880528d2f13c83a 100644 (file)
--- 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 e6c1f3392f2cb878602547bb841a91a0bf08d8e8..4d6706b67d15582a62473582766d1a2425dc5c47 100644 (file)
--- 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 9bc3825d1399c422d49e8dfa79476a6fd641086b..8408d9a243275c55cb555c3a34d107fa0ecaca3a 100644 (file)
--- 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 d3ed866656729865417bb04f8272a89380459c91..80cae35ed7a3ec81f9f326e935ad756d822ebdb1 100644 (file)
--- 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 18fb694a6580a8630cd17f65a2c5437505c8ea69..b43733a5ca06cba33380e558d04c3d98afd301ac 100644 (file)
--- 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 fe7ae8f37c4eef9789616b367f3ae06a446f2bf9..2f92d9557c9caf45a3f1adc52779599c5ea9f95d 100644 (file)
--- 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 4268c9aa9b677e7f6fd7c91723f896510975a025..3891ca8d67b2cb83a2a0f76b3beac64e3e36977e 100644 (file)
--- 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 02296006d341c24b68ced05ff6606a13143fa9b3..70b89c2ef6d7b9360c946deb3d802f3613b68e07 100644 (file)
--- 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 a450c3a4eb9888f779343c84d2f2bd3a465da788..1dc912ed0315b322fdf96d9e04fadc0d37bc84a7 100644 (file)
--- 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 <string.h>
 #include "ircd_md5.h"

diff --git a/ircd/ircd_snprintf.c b/ircd/ircd_snprintf.c
index 5945afafb1843ec8f580e7781a4397d6c8e894da..91a9f082283648467c7f76c7a769d604081bb0d4 100644 (file)
--- 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 e4692e7712fd8bd8c22cdb8c5c4e5870e6b2703a..2eeda9977cfb0fa7d04449087d8cd5bfd6f83104 100644 (file)
--- 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 06731b98e1973b302db891c65c49f201c27f54a0..5baa898abad1a6ce15b4a3aad425e5a4d06b69a3 100644 (file)
--- 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 <tomh@inxpress.net>
  */
+/** @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 1232d2dea3efc4b051b2db65ac424623ae5428ec..adab64f0f13ca584fca1317ca0852f45ad64380c 100644 (file)
--- 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 980c282165e0e821b4e11bc0daddb62a5916773c..23137fd022db16c00390ed6857fda8eb0a9bab1e 100644 (file)
--- 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 1371be9423f53f73b9d6627d4772a102971bf517..82855b0d6e768216716c7892855075a6d3142b5b 100644 (file)
--- 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 f42e01ce92e6caadc00910fc8201ce61263c9445..ead7f11b2c882e5675356fcc48778b60e8e19c32 100644 (file)
--- 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 ee47821c28e9c2243e7ab57c5b47a40e2722eacf..3342c8a26194648e9b496f0807fdb31f9b8849b8 100644 (file)
--- 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 b53fbf4582541354600c32c242a5f59b95a80d6c..6bc641b788cf69a7b7eb035d538435fa4ff41f63 100644 (file)
--- a/ircd/userload.c
+++ b/ircd/userload.c
@@ -1,7 +1,7 @@
 /*
  * Userload module by Michael L. VanLoon (mlv) <michaelv@iastate.edu>
  * Written 2/93.  Originally grafted into irc2.7.2g 4/93.
- * 
+ *
  * Rewritten 9/97 by Carlo Wood (Run) <carlo@runaway.xs4all.nl>
  * 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"