doc/module-xbt.doc

   1 /** @addtogroup XBT_API
   2  *
   3  *   - Grounding features
   4  *     - \ref XBT_log
   5  *     - \ref XBT_error
   6  *     - \ref XBT_config
   7  *   - Data structures
   8  *     - \ref XBT_dynar
   9  *     - \ref XBT_dict
  10  *     - \ref XBT_set
  11  *       Data are associated to both an ID (0(1) search) and a name
  12  *     - \ref XBT_fifo
  13  *     - \ref XBT_swag
  14  *     - \ref XBT_heap
  15  *   - Portability support. The targeted audiance of this portability support
  16  *     is merly the programming environments (\ref MSG_API, \ref GRAS_API and
  17  *     \ref SMPI_API), not the user code which should get its portability from
  18  *     the used programming environment.
  19  *     - \ref XBT_context
  20  *
  21  *  @{
  22  */
  23
  24 /* ************* *
  25  * * GROUNDING * *
  26  * ************* */
  27     /** @defgroup XBT_log Logging support
  28      *  @brief A generic logging facility in the spirit of log4j (grounding feature)
  29      *  @{
  30      */
  31
  32         /** \defgroup XBT_log_cats Existing log categories
  33          *  \ingroup XBT_log
  34          *  \brief (automatically extracted)
  35          *
  36          *  This is the list of all existing log categories in SimGrid.
  37          *  This list was automatically extracted from the source code by
  38          *  the src/xbt_log_extract_hierarchy utility.
  39          *
  40          *  You can thus be certain that it is uptodate, but it may somehow
  41          *  lack a final manual touch.
  42          *  Anyway, nothing's perfect ;)
  43          */
  44
  45     /** @} */
  46
  47
  48     /** @defgroup XBT_error Error tracking support
  49      *  @brief A set of macros easing the handling of errors (grounding feature)
  50      */
  51
  52     /** @defgroup XBT_config Configuration support
  53      *  @brief Changing the configuration of SimGrid components (grounding feature)
  54      */
  55
  56 /* **************** *
  57  * * DATA STRUCTS * *
  58  * **************** */
  59     /** @defgroup XBT_dynar A generic dynamic array
  60      *  @brief DynArr are dynamically sized vector which may contain any type of variables.
  61      */
  62
  63     /** @defgroup XBT_dict A generic dictionnary
  64      *  @brief The dictionnary data structure (comparable to hash tables)
  65      */
  66
  67     /** \defgroup XBT_set A generic set datatype
  68      * \brief A data container consisting in \ref XBT_dict and \ref XBT_dynar
  69      */
  70
  71 /**       \addtogroup XBT_fifo
  72           \ingroup XBT_API */
  73 /**        \addtogroup XBT_swag
  74           \ingroup XBT_API */
  75 /**       \addtogroup XBT_heap
  76           \ingroup XBT_API */
  77
  78 /* *************** *
  79  * * PORTABILITY * *
  80  * *************** */
  81
  82  /** \defgroup XBT_context Portable context implementation
  83   *  \brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
  84   *  for non-preemptible threads.
  85   *
  86   *  You shouldn't use it directly since it is merly intended to ease the
  87   *  implementation of the serveral programmation environment of the
  88   *  SimGrid toolkit (nammely, \ref MSG_API, \ref GRAS_API and \ref SMPI_API).
  89   *
  90   *  You should use those mecanism instead.
  91   */