]> arthur.barton.de Git - ngircd-alex.git/blobdiff - src/ngircd/log.c
do not call Conn_Close when io_event_create fails
[ngircd-alex.git] / src / ngircd / log.c
index 396555ee73555e84fb58e4d85b7a779b450ca3b9..9c4daf557f8239bd0c6307aef02a23ad4ee0208d 100644 (file)
@@ -14,7 +14,7 @@
 
 #include "portab.h"
 
-static char UNUSED id[] = "$Id: log.c,v 1.60 2006/02/08 17:33:28 fw Exp $";
+static char UNUSED id[] = "$Id: log.c,v 1.62 2006/08/05 09:16:21 fw Exp $";
 
 #include "imp.h"
 #include <assert.h>
@@ -162,6 +162,16 @@ Log_Exit( void )
 } /* Log_Exit */
 
 
+/**
+ * Log function for debug messages.
+ * This function is only functional when the program is compiled with debug
+ * code enabled; otherwise it is an empty function which the compiler will
+ * hopefully mangle down to "nothing" (see log.h). Therefore you should use
+ * LogDebug(...) in favor to Log(LOG_DEBUG, ...).
+ * @param Format Format string like printf().
+ * @param ... Further arguments.
+ */
+#ifdef DEBUG
 # ifdef PROTOTYPES
 GLOBAL void
 LogDebug( const char *Format, ... )
@@ -170,8 +180,7 @@ GLOBAL void
 LogDebug( Format, va_alist )
 const char *Format;
 va_dcl
-# endif
-#ifdef DEBUG
+# endif /* PROTOTYPES */
 {
        char msg[MAX_LOG_MSG_LEN];
        va_list ap;
@@ -186,11 +195,18 @@ va_dcl
        va_end( ap );
        Log(LOG_DEBUG, "%s", msg);
 }
-#else
-{ /* do nothing */ }
 #endif /* DEBUG */
 
-       
+
+/**
+ * Logging function of ngIRCd.
+ * This function logs messages to the console and/or syslog, whichever is
+ * suitable for the mode ngIRCd is running in (daemon vs. non-daemon).
+ * Please note: you sould use LogDebug(...) for debug messages!
+ * @param Level syslog level (LOG_xxx)
+ * @param Format Format string like printf().
+ * @param ... Further arguments.
+ */
 #ifdef PROTOTYPES
 GLOBAL void
 Log( int Level, const char *Format, ... )