Documentation of xbt_log module unmercifully reworked

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

diff --git a/include/xbt/log.h b/include/xbt/log.h
index 3c7e846..4f4c38b 100644 (file)
--- a/include/xbt/log.h
+++ b/include/xbt/log.h
@@ -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;
              
 
@@ -47,8 +47,8 @@ typedef enum {
 
 
 /**
- * \def XBT_LOG_STATIC_THRESHOLD:
- * \ingroup XBT_log
+ * @def XBT_LOG_STATIC_THRESHOLD
+ * @ingroup XBT_log
  *
  * All logging requests with priority < XBT_LOG_STATIC_THRESHOLD are disabled at
  * compile time, i.e., compiled out.
@@ -89,6 +89,7 @@ typedef enum {
  * \param catName name of new category
  * \param parent father of the new category in the tree
  * \param desc string describing the purpose of this category
+ * \hideinitializer
  *
  * Defines a new subcategory of the parent. 
  */
@@ -100,6 +101,7 @@ typedef enum {
  * \ingroup XBT_log  
  * \param catName name of new category
  * \param desc string describing the purpose of this category
+ * \hideinitializer
  *
  * Creates a new subcategory of the root category.
  */
@@ -108,6 +110,7 @@ typedef enum {
 /**
  * \ingroup XBT_log  
  * \param cname name of the cat
+ * \hideinitializer
  *
  * Indicates which category is the default one.
  */
@@ -123,6 +126,7 @@ typedef enum {
  * \ingroup XBT_log  
  * \param cname name of the cat
  * \param desc string describing the purpose of this category
+ * \hideinitializer
  *
  * Creates a new subcategory of the root category and makes it the default
  * (used by macros that don't explicitly specify a category).
@@ -136,6 +140,7 @@ typedef enum {
  * \param cname name of the cat
  * \param parent name of the parent
  * \param desc string describing the purpose of this category
+ * \hideinitializer
  *
  * Creates a new subcategory of the parent category and makes it the default
  * (used by macros that don't explicitly specify a category).
@@ -147,6 +152,7 @@ typedef enum {
 /**
  * \ingroup XBT_log  
  * \param cname name of the cat
+ * \hideinitializer
  *
  * Indicates that a category you'll use in this file (to get subcategories of it, 
  * for example) really lives in another file.
@@ -241,6 +247,7 @@ extern xbt_log_appender_t xbt_log_default_appender;
  * \ingroup XBT_log 
  * \param catName name of the category
  * \param priority minimal priority to be enabled to return true
+ * \hideinitializer
  *
  * Returns true if the given priority is enabled for the category.
  * If you have expensive expressions that are computed outside of the log
@@ -279,7 +286,7 @@ extern xbt_log_appender_t xbt_log_default_appender;
 #define _XBT_LOG_PRE(catv, priority) do {                              \
      if (_XBT_LOG_ISENABLEDV(catv, priority)) {                        \
          s_xbt_log_event_t _log_ev =                                   \
-             {&(catv),priority,__FILE__,_XBT_GNUC_FUNCTION,__LINE__};         \
+             {&(catv),priority,__FILE__,_XBT_FUNCTION,__LINE__};         \
          _xbt_log_event_log(&_log_ev
 
 #define _XBT_LOG_POST                          \
@@ -535,12 +542,12 @@ extern xbt_log_appender_t xbt_log_default_appender;
 #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)
-#define XBT_IN2(fmt,a,b)     LOG3(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_GNUC_FUNCTION, a,b)
-#define XBT_IN3(fmt,a,b,c)   LOG4(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_GNUC_FUNCTION, a,b,c)
-#define XBT_IN4(fmt,a,b,c,d) LOG5(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_GNUC_FUNCTION, a,b,c,d)
-#define XBT_OUT              LOG1(xbt_log_priority_trace, "<< end of %s",       _XBT_GNUC_FUNCTION)
+#define XBT_IN               LOG1(xbt_log_priority_trace, ">> begin of %s",     _XBT_FUNCTION)
+#define XBT_IN1(fmt,a)       LOG2(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a)
+#define XBT_IN2(fmt,a,b)     LOG3(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a,b)
+#define XBT_IN3(fmt,a,b,c)   LOG4(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a,b,c)
+#define XBT_IN4(fmt,a,b,c,d) LOG5(xbt_log_priority_trace, ">> begin of %s" fmt, _XBT_FUNCTION, a,b,c,d)
+#define XBT_OUT              LOG1(xbt_log_priority_trace, "<< end of %s",       _XBT_FUNCTION)
 #define XBT_HERE             LOG0(xbt_log_priority_trace, "-- was here")
 
 #endif /* ! _XBT_LOG_H_ */