Doxyfy s_debug.h and s_debug.c.

Add DEBUGMODE to Doxygen PREDEFINED list to index debugging code.

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

diff --git a/Doxyfile b/Doxyfile
index d59dee498eea154e866d4703c3bc97f4d11fed98..17b81f5c5e3e1829d6faf23d3e791b4b5a748528 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -875,7 +875,7 @@ INCLUDE_FILE_PATTERNS  =
 # or name=definition (no spaces). If the definition and the = are
 # omitted =1 is assumed.
 
-PREDEFINED             =
+PREDEFINED             = DEBUGMODE
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
 # this tag can be used to specify a list of macro names that should be expanded.

diff --git a/include/s_debug.h b/include/s_debug.h
index 35e84d0053c97e70a50cebab2e67f125106f5cd3..3359b10f5b2cc9aa0a1b515e5cc9810c159e379e 100644 (file)
--- a/include/s_debug.h
+++ b/include/s_debug.h
@@ -25,23 +25,25 @@ struct StatDesc;
  * Macro's
  */
 
+/** If DEBUGMODE is defined, output the debug message.
+ * @param x A two-or-more element list containing level, format and arguments.
+ */
 #define Debug(x) debug x
-#define LOGFILE LPATH
+#define LOGFILE LPATH /**< Path to debug log file. */
 
 /*
  * defined debugging levels
  */
-#define DEBUG_FATAL   0
-#define DEBUG_ERROR   1  /* report_error() and other errors that are found */
-#define DEBUG_NOTICE  3
-#define DEBUG_DNS     4  /* used by all DNS related routines - a *lot* */
-#define DEBUG_INFO    5  /* general useful info */
-#define DEBUG_NUM     6  /* numerics */
-#define DEBUG_SEND    7  /* everything that is sent out */
-#define DEBUG_DEBUG   8  /* everything that is received */ 
-#define DEBUG_MALLOC  9  /* malloc/free calls */
-#define DEBUG_LIST   10  /* debug list use */
-#define DEBUG_ENGINE 11  /* debug event engine; can dump gigabyte logs */
+#define DEBUG_FATAL   0  /**< fatal error */
+#define DEBUG_ERROR   1  /**< report_error() and other errors that are found */
+#define DEBUG_NOTICE  3  /**< somewhat useful, but non-critical, messages */
+#define DEBUG_DNS     4  /**< used by all DNS related routines - a *lot* */
+#define DEBUG_INFO    5  /**< general useful info */
+#define DEBUG_SEND    7  /**< everything that is sent out */
+#define DEBUG_DEBUG   8  /**< everything that is received */ 
+#define DEBUG_MALLOC  9  /**< malloc/free calls */
+#define DEBUG_LIST   10  /**< debug list use */
+#define DEBUG_ENGINE 11  /**< debug event engine; can dump gigabyte logs */
 
 /*
  * proto types

diff --git a/ircd/s_debug.c b/ircd/s_debug.c
index 91639d580737cb06da4855cf1551f4a7aa47a6fe..1232d2dea3efc4b051b2db65ac424623ae5428ec 100644 (file)
--- a/ircd/s_debug.c
+++ b/ircd/s_debug.c
@@ -63,6 +63,9 @@
  */
 static char serveropts[256]; /* should be large enough for anything */
 
+/** Return a string describing important configuration information.
+ * @return Pointer to a static buffer.
+ */
 const char* debug_serveropts(void)
 {
   int bp;
@@ -111,15 +114,14 @@ const char* debug_serveropts(void)
   return serveropts;
 }
 
-/*
- * debug_init
- *
+/** Initialize debugging.
  * If the -t option is not given on the command line when the server is
  * started, all debugging output is sent to the file set by LPATH in config.h
  * Here we just open that file and make sure it is opened to fd 2 so that
  * any fprintf's to stderr also goto the logfile.  If the debuglevel is not
  * set from the command line by -x, use /dev/null as the dummy logfile as long
  * as DEBUGMODE has been defined, else dont waste the fd.
+ * @param use_tty Passed to log_debug_init().
  */
 void debug_init(int use_tty)
 {
@@ -132,6 +134,12 @@ void debug_init(int use_tty)
 }
 
 #ifdef DEBUGMODE
+/** Log a debug message using a va_list.
+ * If the current #debuglevel is less than \a level, do not display.
+ * @param level Debug level for message.
+ * @param form Format string, passed to log_vwrite().
+ * @param vl Varargs argument list for format string.
+ */
 void vdebug(int level, const char *form, va_list vl)
 {
   static int loop = 0;
@@ -146,6 +154,11 @@ void vdebug(int level, const char *form, va_list vl)
   errno = err;
 }
 
+/** Log a debug message using a variable number of arguments.
+ * This is a simple wrapper around debug(\a level, \a form, vl).
+ * @param level Debug level for message.
+ * @param form Format string of message.
+ */
 void debug(int level, const char *form, ...)
 {
   va_list vl;
@@ -154,18 +167,20 @@ void debug(int level, const char *form, ...)
   va_end(vl);
 }
 
+/** Send a literal RPL_STATSDEBUG message to a user.
+ * @param cptr Client to receive the message.
+ * @param msg Text message to send to user.
+ */
 static void debug_enumerator(struct Client* cptr, const char* msg)
 {
   assert(0 != cptr);
   send_reply(cptr, SND_EXPLICIT | RPL_STATSDEBUG, ":%s", msg);
 }
 
-/*
- * This is part of the STATS replies. There is no offical numeric for this
- * since this isnt an official command, in much the same way as HASH isnt.
- * It is also possible that some systems wont support this call or have
- * different field names for "struct rusage".
- * -avalon
+/** Send resource usage statistics to a client.
+ * @param cptr Client to send data to.
+ * @param sd StatDesc that generated the stats request (ignored).
+ * @param param Extra parameter from user (ignored).
  */
 void send_usage(struct Client *cptr, const struct StatDesc *sd,
                 char *param)
@@ -177,6 +192,11 @@ void send_usage(struct Client *cptr, const struct StatDesc *sd,
 }
 #endif /* DEBUGMODE */
 
+/** Report memory usage statistics to a client.
+ * @param cptr Client to send data to.
+ * @param sd StatDesc that generated the stats request (ignored).
+ * @param param Extra parameter from user (ignored).
+ */
 void count_memory(struct Client *cptr, const struct StatDesc *sd,
                   char *param)
 {