Document another public value, don't document in doxygen the private ones (ie, mask...

[simgrid.git] / include / xbt / log.h

diff --git a/include/xbt/log.h b/include/xbt/log.h
index 0de5738..207016b 100644 (file)
--- a/include/xbt/log.h
+++ b/include/xbt/log.h
@@ -15,9 +15,9 @@
 #ifndef _XBT_LOG_H_
 #define _XBT_LOG_H_
 
-#include <stdarg.h>
+#include "xbt/misc.h"
 
-#include "xbt/sysdep.h"
+#include <stdarg.h>
 
 /**\brief Log priorities
  * \ingroup XBT_log
@@ -25,8 +25,8 @@
  * The different existing priorities.
 */
 typedef enum {
-  xbt_log_priority_none          = 0,  /**< used internally (don't poke with) */
-  xbt_log_priority_trace         = 1, 
+  xbt_log_priority_none          = 0,  /* used internally (don't poke with) */
+  xbt_log_priority_trace         = 1,  /**< enter and return of some functions */
   xbt_log_priority_debug         = 2,  /**< crufty output  */
   xbt_log_priority_verbose       = 3,  /**< verbose output for the user wanting more */
   xbt_log_priority_info          = 4,  /**< output about the regular functionning */
@@ -36,7 +36,7 @@ typedef enum {
 
   xbt_log_priority_infinite      = 8,  /**< value for XBT_LOG_STATIC_THRESHOLD to not log */
 
-  xbt_log_priority_uninitialized = -1  /**< used internally (don't poke with) */
+  xbt_log_priority_uninitialized = -1  /* used internally (don't poke with) */
 } e_xbt_log_priority_t;
              
 
@@ -74,6 +74,16 @@ typedef enum {
 /* The root of the category hierarchy. */
 #define XBT_LOG_ROOT_CAT   root
 
+/* XBT_LOG_NEW_SUBCATEGORY_helper:
+ * Implementation of XBT_LOG_NEW_SUBCATEGORY, which must declare "extern parent" in addition
+ * to avoid an extra declaration of root when XBT_LOG_NEW_SUBCATEGORY is called by
+ * XBT_LOG_NEW_CATEGORY */
+#define XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \
+    s_xbt_log_category_t _XBT_LOGV(catName) = {       \
+        &_XBT_LOGV(parent), 0, 0,                    \
+        #catName, xbt_log_priority_uninitialized, 1, \
+        0, 1                                          \
+    }
 /**
  * \ingroup XBT_log
  * \param catName name of new category
@@ -82,13 +92,9 @@ typedef enum {
  *
  * Defines a new subcategory of the parent. 
  */
-#define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc) \
-    extern s_xbt_log_category_t _XBT_LOGV(parent);    \
-    s_xbt_log_category_t _XBT_LOGV(catName) = {       \
-        &_XBT_LOGV(parent), 0, 0,                    \
-        #catName, xbt_log_priority_uninitialized, 1, \
-        0, 1                                          \
-    }
+#define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc)    \
+    extern s_xbt_log_category_t _XBT_LOGV(parent);        \
+    XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \
 
 /**
  * \ingroup XBT_log  
@@ -97,7 +103,7 @@ typedef enum {
  *
  * Creates a new subcategory of the root category.
  */
-#define XBT_LOG_NEW_CATEGORY(catName,desc)  XBT_LOG_NEW_SUBCATEGORY(catName, XBT_LOG_ROOT_CAT, desc)
+#define XBT_LOG_NEW_CATEGORY(catName,desc)  XBT_LOG_NEW_SUBCATEGORY_helper(catName, XBT_LOG_ROOT_CAT, desc)
 
 /**
  * \ingroup XBT_log  
@@ -392,7 +398,7 @@ extern xbt_log_appender_t xbt_log_default_appender;
  * for sake of clarity. They just differ in the number of arguments passed
  * along with the format string.
  */
-/*@{*/
+/* @{ */
 #define DEBUG0(f)                   LOG0(xbt_log_priority_debug, f)
 #define DEBUG1(f,a1)                LOG1(xbt_log_priority_debug, f,a1)
 #define DEBUG2(f,a1,a2)             LOG2(xbt_log_priority_debug, f,a1,a2)
@@ -402,7 +408,7 @@ extern xbt_log_appender_t xbt_log_default_appender;
 #define DEBUG6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6)
 #define DEBUG7(f,a1,a2,a3,a4,a5,a6,a7) LOG7(xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6,a7)
 #define DEBUG8(f,a1,a2,a3,a4,a5,a6,a7,a8) LOG8(xbt_log_priority_debug, f,a1,a2,a3,a4,a5,a6,a7,a8)
-/*@}*/
+/* @} */
 
 /** \name VERB
  * \ingroup XBT_log
@@ -419,7 +425,7 @@ extern xbt_log_appender_t xbt_log_default_appender;
  * for sake of clarity. They just differ in the number of arguments passed
  * along with the format string.
  */
-/*@{*/
+/* @{ */
 #define VERB0(f)                   LOG0(xbt_log_priority_verbose, f)
 #define VERB1(f,a1)                LOG1(xbt_log_priority_verbose, f,a1)
 #define VERB2(f,a1,a2)             LOG2(xbt_log_priority_verbose, f,a1,a2)
@@ -427,7 +433,7 @@ extern xbt_log_appender_t xbt_log_default_appender;
 #define VERB4(f,a1,a2,a3,a4)       LOG4(xbt_log_priority_verbose, f,a1,a2,a3,a4)
 #define VERB5(f,a1,a2,a3,a4,a5)    LOG5(xbt_log_priority_verbose, f,a1,a2,a3,a4,a5)
 #define VERB6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_verbose, f,a1,a2,a3,a4,a5,a6)
-/*@}*/
+/* @} */
 
 /** \name INFO
  * \ingroup XBT_log
@@ -444,7 +450,7 @@ extern xbt_log_appender_t xbt_log_default_appender;
  * for sake of clarity. They just differ in the number of arguments passed
  * along with the format string.
  */
-/*@{*/
+/* @{ */
 #define INFO0(f)                   LOG0(xbt_log_priority_info, f)
 #define INFO1(f,a1)                LOG1(xbt_log_priority_info, f,a1)
 #define INFO2(f,a1,a2)             LOG2(xbt_log_priority_info, f,a1,a2)
@@ -452,7 +458,7 @@ extern xbt_log_appender_t xbt_log_default_appender;
 #define INFO4(f,a1,a2,a3,a4)       LOG4(xbt_log_priority_info, f,a1,a2,a3,a4)
 #define INFO5(f,a1,a2,a3,a4,a5)    LOG5(xbt_log_priority_info, f,a1,a2,a3,a4,a5)
 #define INFO6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_info, f,a1,a2,a3,a4,a5,a6)
-/*@}*/
+/* @} */
 
 /** \name WARN
  * \ingroup XBT_log
@@ -469,7 +475,7 @@ extern xbt_log_appender_t xbt_log_default_appender;
  * for sake of clarity. They just differ in the number of arguments passed
  * along with the format string.
  */
-/*@{*/
+/* @{ */
 #define WARN0(f)                   LOG0(xbt_log_priority_warning, f)
 #define WARN1(f,a1)                LOG1(xbt_log_priority_warning, f,a1)
 #define WARN2(f,a1,a2)             LOG2(xbt_log_priority_warning, f,a1,a2)
@@ -477,7 +483,7 @@ extern xbt_log_appender_t xbt_log_default_appender;
 #define WARN4(f,a1,a2,a3,a4)       LOG4(xbt_log_priority_warning, f,a1,a2,a3,a4)
 #define WARN5(f,a1,a2,a3,a4,a5)    LOG5(xbt_log_priority_warning, f,a1,a2,a3,a4,a5)
 #define WARN6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_warning, f,a1,a2,a3,a4,a5,a6)
-/*@}*/
+/* @} */
 
 /** \name ERROR
  * \ingroup XBT_log
@@ -494,7 +500,7 @@ extern xbt_log_appender_t xbt_log_default_appender;
  * for sake of clarity. They just differ in the number of arguments passed
  * along with the format string.
  */
-/*@{*/
+/* @{ */
 #define ERROR0(f)                   LOG0(xbt_log_priority_error, f)
 #define ERROR1(f,a1)                LOG1(xbt_log_priority_error, f,a1)
 #define ERROR2(f,a1,a2)             LOG2(xbt_log_priority_error, f,a1,a2)
@@ -502,7 +508,7 @@ extern xbt_log_appender_t xbt_log_default_appender;
 #define ERROR4(f,a1,a2,a3,a4)       LOG4(xbt_log_priority_error, f,a1,a2,a3,a4)
 #define ERROR5(f,a1,a2,a3,a4,a5)    LOG5(xbt_log_priority_error, f,a1,a2,a3,a4,a5)
 #define ERROR6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_error, f,a1,a2,a3,a4,a5,a6)
-/*@}*/
+/* @} */
 
 /** \name CRITICAL
  * \ingroup XBT_log
@@ -519,7 +525,7 @@ extern xbt_log_appender_t xbt_log_default_appender;
  * for sake of clarity. They just differ in the number of arguments passed
  * along with the format string.
  */
-/*@{*/
+/* @{ */
 #define CRITICAL0(f)                   LOG0(xbt_log_priority_critical, f)
 #define CRITICAL1(f,a1)                LOG1(xbt_log_priority_critical, f,a1)
 #define CRITICAL2(f,a1,a2)             LOG2(xbt_log_priority_critical, f,a1,a2)
@@ -527,7 +533,7 @@ extern xbt_log_appender_t xbt_log_default_appender;
 #define CRITICAL4(f,a1,a2,a3,a4)       LOG4(xbt_log_priority_critical, f,a1,a2,a3,a4)
 #define CRITICAL5(f,a1,a2,a3,a4,a5)    LOG5(xbt_log_priority_critical, f,a1,a2,a3,a4,a5)
 #define CRITICAL6(f,a1,a2,a3,a4,a5,a6) LOG6(xbt_log_priority_critical, f,a1,a2,a3,a4,a5,a6)
-/*@}*/
+/* @} */
 
 #define XBT_IN               LOG1(xbt_log_priority_trace, ">> begin of %s",     _XBT_GNUC_FUNCTION)
 #define XBT_IN1(fmt,a)       LOG2(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_GNUC_FUNCTION, a)