document DEFINE key in return value

[imager.git] / log.h

diff --git a/log.h b/log.h
index cd8b12134a2d6eedde5076aa8b19a3a68aa139e1..5b1f483957b0bdecc315125fdf3422508bed75d3 100644 (file)
--- a/log.h
+++ b/log.h
@@ -10,14 +10,26 @@
    global: creates a global variable FILE* lg_file
 */
 
-void m_lhead ( const char *file, int line  );
-void init_log( const char *name, int onoff );
-void m_loog(int level,const char *msg, ... );
-void m_fatal ( int exitcode,const char *fmt, ... );
+void i_lhead ( const char *file, int line  );
+void i_init_log( const char *name, int onoff );
+void i_loog(int level,const char *msg, ... );
+void i_fatal ( int exitcode,const char *fmt, ... );
 
+/*
+=item mm_log((level, format, ...))
+=category Logging
+
+This is the main entry point to logging. Note that the extra set of
+parentheses are required due to limitations in C89 macros.
+
+This will format a string with the current file and line number to the
+log file if logging is enabled.
+
+=cut
+*/
 
 #ifdef IMAGER_LOG
-#define mm_log(x) { m_lhead(__FILE__,__LINE__); m_loog x; } 
+#define mm_log(x) { i_lhead(__FILE__,__LINE__); i_loog x; } 
 #else
 #define mm_log(x)
 #endif