XBT documentation reorganization. module-xbt only contains the structure, module...

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

diff --git a/include/xbt/log.h b/include/xbt/log.h
index 970571b..54a77cb 100644 (file)
--- a/include/xbt/log.h
+++ b/include/xbt/log.h
@@ -7,6 +7,31 @@
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
+/** @addtogroup XBT_log
+ *  @brief A generic logging facility in the spirit of log4j (grounding feature)
+ *
+ * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]
+ *                <tr><td><b>Prev</b>   <td> [\ref XBT_ex]
+ *                <tr><td><b>Next</b>   <td> [\ref XBT_error]     
+ *                <tr><td><b>Down</b>   <td> [\ref XBT_log_cats]        </table></center>
+ *
+ */
+ 
+/** \defgroup XBT_log_cats Existing log categories
+ *  \ingroup XBT_log
+ *  \brief (automatically extracted) 
+ *     
+ * <center><table><tr><td><b>Top</b>    <td> [\ref index]::[\ref XBT_API]::[\ref XBT_log] </table></center>
+ *
+ *  This is the list of all existing log categories in SimGrid.
+ *  This list was automatically extracted from the source code by
+ *  the src/xbt_log_extract_hierarchy utility.
+ *     
+ *  You can thus be certain that it is uptodate, but it may somehow
+ *  lack a final manual touch.
+ *  Anyway, nothing's perfect ;)
+ */
+
 /* XBT_LOG_MAYDAY: define this to replace the logging facilities with basic
    printf function. Useful to debug the logging facilities themselves */
 #undef XBT_LOG_MAYDAY
@@ -89,6 +114,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 +126,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 +135,7 @@ typedef enum {
 /**
  * \ingroup XBT_log  
  * \param cname name of the cat
+ * \hideinitializer
  *
  * Indicates which category is the default one.
  */
@@ -123,6 +151,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 +165,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 +177,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 +272,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