First commit to cleanup log module documentation.

[bertos.git] / bertos / cfg / log.h

diff --git a/bertos/cfg/log.h b/bertos/cfg/log.h
index 444c1d73219e3b36323d0e5ec9d9eca6258c454f..ff7ddc642c5a761b2545d8651ffd40317933bfdd 100644 (file)
--- a/bertos/cfg/log.h
+++ b/bertos/cfg/log.h
@@ -83,9 +83,9 @@
  * LOG_LEVEL and LOG_VERBOSE macros must be defined before to include log module,
  * otherwise the log module use a default settings.
  *
- * \version $Id$
  * \author Daniele Basile <asterix@develer.com>
  *
+ * $WIZ$
  */
 
 #ifndef CFG_LOG_H
@@ -114,14 +114,14 @@
  * The priority level go from error (highest) to info (lowest) (see cfg/debug.h
  * for more detail).
  *
- * $WIZARD_LIST = {
- * "log_level" : ["LOG_LVL_NONE", "LOG_LVL_ERR", "LOG_LVL_WARN", "LOG_LVL_INFO"]
- * }
+ * $WIZ$ log_level = "LOG_LVL_NONE", "LOG_LVL_ERR", "LOG_LVL_WARN", "LOG_LVL_INFO"
+ * \{
  */
 #define LOG_LVL_NONE      0
 #define LOG_LVL_ERR       1
 #define LOG_LVL_WARN      2
 #define LOG_LVL_INFO      3
+/** \} */
 
 /**
  * \name Logging format
@@ -129,12 +129,12 @@
  * There are two logging format: terse and verbose.  The latter prepends
  * function names and line number information to each log entry.
  *
- * $WIZARD_LIST = {
- * "log_format" : ["LOG_FMT_VERBOSE", "LOG_FMT_TERSE"]
- * }
+ * $WIZ$ log_format = "LOG_FMT_VERBOSE", "LOG_FMT_TERSE"
+ * \{
  */
 #define LOG_FMT_VERBOSE   1
 #define LOG_FMT_TERSE     0
+/** \} */
 
 #if LOG_FORMAT == LOG_FMT_VERBOSE
        #define LOG_PRINT(str_level, str,...)    kprintf("%s():%d:%s: " str, __func__, __LINE__, str_level, ## __VA_ARGS__)
@@ -146,20 +146,27 @@
 
 #if LOG_LEVEL >= LOG_LVL_ERR
        #define LOG_ERR(str,...)       LOG_PRINT("ERR", str, ## __VA_ARGS__)
+       #define LOG_ERRB(x)            x
 #else
-       #define LOG_ERR(str,...)       /* Nothing */
+       INLINE void LOG_ERR(UNUSED_ARG(const char *, fmt), ...) { /* nop */ }
+       #define LOG_ERRB(x)            /* Nothing */
 #endif
 
 #if LOG_LEVEL >= LOG_LVL_WARN
        #define LOG_WARN(str,...)       LOG_PRINT("WARN", str, ## __VA_ARGS__)
+       #define LOG_WARNB(x)            x
 #else
-       #define LOG_WARN(str,...)       /* Nothing */
+       INLINE void LOG_WARN(UNUSED_ARG(const char *, fmt), ...) { /* nop */ }
+       #define LOG_WARNB(x)            /* Nothing */
 #endif
 
 #if LOG_LEVEL >= LOG_LVL_INFO
        #define LOG_INFO(str,...)       LOG_PRINT("INFO", str, ## __VA_ARGS__)
+       #define LOG_INFOB(x)            x
 #else
-       #define LOG_INFO(str,...)       /* Nothing */
+       INLINE void LOG_INFO(UNUSED_ARG(const char *, fmt), ...) { /* nop */ }
+       #define LOG_INFOB(x)            /* Nothing */
 #endif
 
+
 #endif /* CFG_LOG_H */