Doxyfy querycmds.h and querycmds.c.

git-svn-id: file:///home/klmitch/undernet-ircu/undernet-ircu-svn/ircu2/trunk@1212 c9e4aea6-c8fd-4c43-8297-357d70d61c8c

diff --git a/include/querycmds.h b/include/querycmds.h
index 3ebdaa568f570b36b230b7d2d731543cec4c69b9..6f96c54757e4a54e45b28b9654e81a0b0db04d6b 100644 (file)
--- a/include/querycmds.h
+++ b/include/querycmds.h
@@ -1,7 +1,6 @@
-/*
- * querycmds.h
- *
- * $Id$
+/** @file
+ * @brief Interface and declarations for client counting functions.
+ * @version $Id$
  */
 #ifndef INCLUDED_querycmds_h
 #define INCLUDED_querycmds_h
@@ -16,22 +15,23 @@ struct Client;
  * Structs
  */
 
+/** Counts types of clients, servers, etc.\ on the network. */
 struct UserStatistics {
   /* Local connections: */
-  unsigned int unknowns;  /* IsUnknown() || IsConnecting() || IsHandshake() */
-  unsigned int local_servers;   /* IsServer() && MyConnect() */
-  unsigned int local_clients;   /* IsUser() && MyConnect() */
+  unsigned int unknowns;  /**< Clients of types: unknown, connecting, handshake */
+  unsigned int local_servers;   /**< Directly connected servers. */
+  unsigned int local_clients;   /**< Directly connected clients. */
 
   /* Global counts: */
-  unsigned int servers;         /* IsServer() || IsMe() */
-  unsigned int clients;         /* IsUser() */
+  unsigned int servers;         /**< Known servers, including #me. */
+  unsigned int clients;         /**< Registered users. */
 
   /* Global user mode changes: */
-  unsigned int inv_clients;     /* IsUser() && IsInvisible() */
-  unsigned int opers;           /* IsUser() && IsOper() */
+  unsigned int inv_clients;     /**< Registered invisible users. */
+  unsigned int opers;           /**< Registered IRC operators. */
 
   /* Misc: */
-  unsigned int channels;
+  unsigned int channels;        /**< Existing channels. */
 };
 
 extern struct UserStatistics UserStats;
@@ -41,9 +41,12 @@ extern struct UserStatistics UserStats;
  */
 
 /* Macros for remote connections: */
+/** Count \a cptr as a new remote client. */
 #define Count_newremoteclient(UserStats, cptr)  (++UserStats.clients, ++(cli_serv(cptr)->clients))
+/** Count a new remote server. */
 #define Count_newremoteserver(UserStats)  (++UserStats.servers)
 
+/** Count a remote user quit. */
 #define Count_remoteclientquits(UserStats,cptr)                \
   do { \
     --UserStats.clients; \
@@ -51,10 +54,13 @@ extern struct UserStatistics UserStats;
       --(cli_serv(cli_user(cptr)->server)->clients); \
   } while (0)
 
+/** Count a remote server quit. */
 #define Count_remoteserverquits(UserStats)      (--UserStats.servers)
 
 /* Macros for local connections: */
+/** Count a new local unknown connection. */
 #define Count_newunknown(UserStats)                     (++UserStats.unknowns)
+/** Update counters when \a cptr goes from unknown to registered. */
 #define Count_unknownbecomesclient(cptr, UserStats) \
   do { \
     --UserStats.unknowns; ++UserStats.local_clients; ++UserStats.clients; \
@@ -70,7 +76,9 @@ extern struct UserStatistics UserStats;
             max_connection_count, max_client_count); \
     } \
   } while(0)
+/** Update counters when \a cptr goes from unknown to server. */
 #define Count_unknownbecomesserver(UserStats)   do { --UserStats.unknowns; ++UserStats.local_servers; ++UserStats.servers; } while(0)
+/** Update counters when \a cptr (a local user) disconnects. */
 #define Count_clientdisconnects(cptr, UserStats) \
   do \
   { \
@@ -78,7 +86,9 @@ extern struct UserStatistics UserStats;
     if (match(feature_str(FEAT_DOMAINNAME), cli_sockhost(cptr)) == 0) \
       --current_load.local_count; \
   } while(0)
+/** Update counters when a local server disconnects. */
 #define Count_serverdisconnects(UserStats)              do { --UserStats.local_servers; --UserStats.servers; } while(0)
+/** Update counters when an unknown client disconnects. */
 #define Count_unknowndisconnects(UserStats)             (--UserStats.unknowns)
 
 /*

diff --git a/ircd/querycmds.c b/ircd/querycmds.c
index 30a69c020aa159744cbebe6fadef7042fefca1f1..e83d2372ec6eac38ad6c7b5707dbbdbf65f70d56 100644 (file)
--- a/ircd/querycmds.c
+++ b/ircd/querycmds.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 Implementation of client counting functions.
+ * @version $Id$
  */
 #include "config.h"
 
@@ -28,9 +30,10 @@
 
 #include <string.h>
 
-/* Counters of client/servers etc. */
+/** Counters of clients, servers etc. */
 struct UserStatistics UserStats;
 
+/** Initialize global #UserStats variable. */
 void init_counters(void)
 {
   memset(&UserStats, 0, sizeof(UserStats));