]> code.delx.au - pulseaudio/blobdiff - polyp/log.h
Comment some more files
[pulseaudio] / polyp / log.h
index 46a86491cdace5dd7a992732cfb65b0370b5ebe6..cf55386cdfbea291565954ffdb452b2836c23b4a 100644 (file)
@@ -1,17 +1,46 @@
 #ifndef foologhfoo
 #define foologhfoo
 
+/* $Id$ */
+
+/***
+  This file is part of polypaudio.
+  polypaudio is free software; you can redistribute it and/or modify
+  it under the terms of the GNU Lesser General Public License as published
+  by the Free Software Foundation; either version 2 of the License,
+  or (at your option) any later version.
+  polypaudio is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  General Public License for more details.
+  You should have received a copy of the GNU Lesser General Public License
+  along with polypaudio; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
+  USA.
+***/
+
 #include "gcc-printf.h"
 
+/* A simple logging subsystem */
+
+/* Where to log to */
 enum pa_log_target {
+    PA_LOG_STDERR,  /* default */
     PA_LOG_SYSLOG,
-    PA_LOG_STDERR,
-    PA_LOG_USER
+    PA_LOG_USER,    /* to user specified function */
+    PA_LOG_NULL     /* to /dev/null */
 };
 
+/* Set an identifcation for the current daemon. Used when logging to syslog. */
 void pa_log_set_ident(const char *p);
+
+/* Set another log target. If t is PA_LOG_USER you may specify a function that is called every log string */
 void pa_log_set_target(enum pa_log_target t, void (*func)(const char*s));
-                       
+
+/* Do a log line */
 void pa_log(const char *format, ...)  PA_GCC_PRINTF_ATTR(1,2);
 
 #endif