From c287cc247d90c996894cab18e870c992e7f84f85 Mon Sep 17 00:00:00 2001 From: Jelmer Vernooij Date: Mon, 6 Mar 2006 00:24:51 +0000 Subject: r13851: More doc improvements. (This used to be commit 936d26ae64b93ef8f8b2fbc632b1c2fd60840405) --- source4/lib/util/debug.c | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'source4/lib/util/debug.c') diff --git a/source4/lib/util/debug.c b/source4/lib/util/debug.c index 1c5bb25753..e4f13ea28e 100644 --- a/source4/lib/util/debug.c +++ b/source4/lib/util/debug.c @@ -29,10 +29,11 @@ * @brief Debug logging **/ -/* this global variable determines what messages are printed */ +/** + * this global variable determines what messages are printed + */ _PUBLIC_ int DEBUGLEVEL; - /* the registered mutex handlers */ static struct { const char *name; @@ -64,7 +65,7 @@ static void log_timestring(int level, const char *location, const char *func) free(s); } -/* +/** the backend for debug messages. Note that the DEBUG() macro has already ensured that the log level has been met before this is called */ @@ -74,9 +75,12 @@ _PUBLIC_ void do_debug_header(int level, const char *location, const char *func) log_task_id(); } -/* +/** the backend for debug messages. Note that the DEBUG() macro has already ensured that the log level has been met before this is called + + @note You should never have to call this function directly. Call the DEBUG() + macro instead. */ _PUBLIC_ void do_debug(const char *format, ...) _PRINTF_ATTRIBUTE(1,2) { -- cgit