-/*
- * 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
* 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