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