added basic ssl support to ircu

[ircu2.10.12-pk.git] / include / s_debug.h

diff --git a/include/s_debug.h b/include/s_debug.h
index a707a718ca218d931405df0483e1bcf972d4b40f..5bdf57e8109641d0f952661edbbd57b5f76a98cc 100644 (file)
--- a/include/s_debug.h
+++ b/include/s_debug.h
@@ -1,12 +1,11 @@
-/*
- * 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
 #ifndef INCLUDED_config_h
-#include "config.h"
+#include "config.h"          /* Needed for DEBUGMODE */
 #endif
 #ifndef INCLUDED_ircd_defs_h
 #include "ircd_defs.h"       /* Needed for HOSTLEN */
@@ -17,6 +16,7 @@
 #endif
 
 struct Client;
+struct StatDesc;
 
 #ifdef DEBUGMODE
 
@@ -24,22 +24,25 @@ struct Client;
  * 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_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
@@ -47,7 +50,8 @@ struct Client;
 
 extern void vdebug(int level, const char *form, va_list vl);
 extern void debug(int level, const char *form, ...);
-extern void send_usage(struct Client *cptr, char *nick);
+extern void send_usage(struct Client *cptr, const struct StatDesc *sd,
+                       char *param);
 
 #else /* !DEBUGMODE */
 
@@ -58,6 +62,7 @@ extern void send_usage(struct Client *cptr, char *nick);
 
 extern const char* debug_serveropts(void);
 extern void debug_init(int use_tty);
-extern void count_memory(struct Client *cptr, char *nick);
+extern void count_memory(struct Client *cptr, const struct StatDesc *sd,
+                         char *param);
 
 #endif /* INCLUDED_s_debug_h */