doc/module-xbt.doc

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