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   /*PORTABILITY*/
  24      /** @defgroup XBT_syscall Malloc and friends */
  25
  26   /*GROUNDING*/
  27      /** @defgroup XBT_ex     Exception support */
  28      /** @defgroup XBT_log    Logging support */
  29      /** @defgroup XBT_error  Assert macro familly */
  30      /** @defgroup XBT_config Configuration support */
  31
  32   /*DATA STRUCTS*/
  33      /** @defgroup XBT_dynar  Dynar: generic dynamic array */
  34      /** @defgroup XBT_dict   Dict: generic dictionnary */
  35      /** @defgroup XBT_set    Set: generic set datatype */
  36      /** @defgroup XBT_fifo   Fifo: generic workqueue */
  37      /** @defgroup XBT_swag   Swag: O(1) set datatype */
  38      /** @defgroup XBT_heap Heap: generic heap data structure */
  39
  40 /* ************************* *
  41  * * PORTABILITY-INTERNALS * *
  42  * ************************* */
  43
  44  /** \defgroup XBT_context Portable context implementation
  45   *  \brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
  46   *  for non-preemptible threads.
  47   *
  48   *  You shouldn't use it directly since it is merly intended to ease the
  49   *  implementation of the serveral programmation environment of the
  50   *  SimGrid toolkit (nammely, \ref MSG_API, \ref GRAS_API and \ref SMPI_API).
  51   *
  52   *  You should use those mechanism instead.
  53   */
  54
  55 /** @} */ End of XBT_API