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