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    /** @defgroup XBT_grounding   Grounding features */
  24    /** @defgroup XBT_adt         Usual data structures */
  25
  26 /** @} */
  27
  28 /*
  29  * +++++++++++++
  30  * + GROUNDING +
  31  * +++++++++++++
  32  */
  33
  34 /** @addtogroup XBT_grounding
  35  *
  36  * Grounding features are the basement of SimGrid. You'll find portable (and
  37  * secure) wrappers to the malloc-like functions, logging support, error
  38  * reporting features, etc.
  39  *
  40  * @{
  41  */
  42      /** @defgroup XBT_syscall Malloc and friends */
  43      /** @defgroup XBT_ex     Exception support */
  44      /** @defgroup XBT_log    Logging support */
  45      /** @defgroup XBT_error  Assert macro familly */
  46      /** @defgroup XBT_config Configuration support */
  47
  48 /** @} */
  49
  50 /*
  51  * ++++++++++++++++
  52  * + DATA STRUCTS +
  53  * ++++++++++++++++
  54  */
  55
  56 /** @addtogroup XBT_adt
  57  *
  58  * Here are the basic data containers that every C programmer rewrites one day.
  59  * You won't need to do so yourself, you lucky one, because we did it for you.
  60  *
  61  * @{
  62  */
  63      /** @defgroup XBT_dynar  Dynar: generic dynamic array */
  64      /** @defgroup XBT_dict   Dict: generic dictionnary */
  65      /** @defgroup XBT_set    Set: generic set datatype */
  66      /** @defgroup XBT_fifo   Fifo: generic workqueue */
  67      /** @defgroup XBT_swag   Swag: O(1) set datatype */
  68      /** @defgroup XBT_heap Heap: generic heap data structure */
  69
  70 /** @} */ End of XBT_adt
  71
  72 /* ************************* *
  73  * * PORTABILITY-INTERNALS * * (not included in documentation)
  74  * ************************* */
  75
  76  /** \defgroup XBT_context Portable context implementation
  77   *  \brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
  78   *  for non-preemptible threads.
  79   *
  80   *  You shouldn't use it directly since it is merely intended to ease the
  81   *  implementation of the several programmation environment of the
  82   *  SimGrid toolkit (namely, \ref MSG_API, \ref GRAS_API and \ref SMPI_API).
  83   *
  84   *  You should use those environments instead.
  85   */
  86