diff options
author | Jelmer Vernooij <jelmer@samba.org> | 2006-03-06 00:24:51 +0000 |
---|---|---|
committer | Gerald (Jerry) Carter <jerry@samba.org> | 2007-10-10 13:52:16 -0500 |
commit | c287cc247d90c996894cab18e870c992e7f84f85 (patch) | |
tree | 01bcabc38219d24c75b4ba494eed2b4e475f7f2a /source4/lib/util/debug.c | |
parent | 77ffddec1911ac5de3a96a36c9476dce6e67f4f4 (diff) | |
download | samba-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.c')
-rw-r--r-- | source4/lib/util/debug.c | 12 |
1 files changed, 8 insertions, 4 deletions
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) { |