doc/module-xbt.doc

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