From c287cc247d90c996894cab18e870c992e7f84f85 Mon Sep 17 00:00:00 2001
From: Jelmer Vernooij <jelmer@samba.org>
Date: Mon, 6 Mar 2006 00:24:51 +0000
Subject: r13851: More doc improvements. (This used to be commit
 936d26ae64b93ef8f8b2fbc632b1c2fd60840405)

---
 source4/lib/util/debug.h | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

(limited to 'source4/lib/util/debug.h')

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};
-- 
cgit