summaryrefslogtreecommitdiff
path: root/source4/lib/util/debug.h
diff options
context:
space:
mode:
authorJelmer Vernooij <jelmer@samba.org>2006-03-06 00:24:51 +0000
committerGerald (Jerry) Carter <jerry@samba.org>2007-10-10 13:52:16 -0500
commitc287cc247d90c996894cab18e870c992e7f84f85 (patch)
tree01bcabc38219d24c75b4ba494eed2b4e475f7f2a /source4/lib/util/debug.h
parent77ffddec1911ac5de3a96a36c9476dce6e67f4f4 (diff)
downloadsamba-c287cc247d90c996894cab18e870c992e7f84f85.tar.gz
samba-c287cc247d90c996894cab18e870c992e7f84f85.tar.bz2
samba-c287cc247d90c996894cab18e870c992e7f84f85.zip
r13851: More doc improvements.
(This used to be commit 936d26ae64b93ef8f8b2fbc632b1c2fd60840405)
Diffstat (limited to 'source4/lib/util/debug.h')
-rw-r--r--source4/lib/util/debug.h20
1 files changed, 18 insertions, 2 deletions
diff --git a/source4/lib/util/debug.h b/source4/lib/util/debug.h
index 4cd5759119..10d7d0697c 100644
--- a/source4/lib/util/debug.h
+++ b/source4/lib/util/debug.h
@@ -18,6 +18,11 @@
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
+/**
+ * @file
+ * @brief Debugging macros
+ */
+
/* If we have these macros, we can add additional info to the header. */
#ifdef HAVE_FUNCTION_MACRO
@@ -54,10 +59,21 @@ extern int DEBUGLEVEL;
do_debug body; \
} \
} while (0)
+/**
+ * Write to the debug log.
+ */
#define DEBUG(level, body) _DEBUG(level, body, True)
+/**
+ * Add data to an existing debug log entry.
+ */
#define DEBUGADD(level, body) _DEBUG(level, body, False)
-#define DEBUGC(class, level, body) DEBUG(level, body)
-#define DEBUGADDC(class, level, body) DEBUGADD(level, body)
+
+/**
+ * Obtain indentation string for the debug log.
+ *
+ * Level specified by n.
+ */
#define DEBUGTAB(n) do_debug_tab(n)
+/** Possible destinations for the debug log */
enum debug_logtype {DEBUG_STDOUT = 0, DEBUG_FILE = 1, DEBUG_STDERR = 2};