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       - \ref XBT_str
   7     - Grounding features
   8       - \ref XBT_ex
   9       - \ref XBT_log
  10       - \ref XBT_error
  11       - \ref XBT_config
  12       - \ref XBT_mallocator
  13     - Data structures
  14       - \ref XBT_dynar
  15       - \ref XBT_dict
  16       - \ref XBT_set
  17         Data are associated to both an ID (0(1) search) and a name
  18       - \ref XBT_fifo
  19       - \ref XBT_queue
  20       - \ref XBT_swag
  21       - \ref XBT_heap
  22     - \ref XBT_misc
  23       - \ref XBT_graph
  24
  25   @{ */
  26    /** @defgroup XBT_grounding   Grounding features */
  27    /** @defgroup XBT_adt         Usual data structures */
  28    /** @defgroup XBT_misc        Misc general purposes library components */
  29 /** @} */
  30
  31
  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_str     String related functions */
  45      /** @defgroup XBT_ex     Exception support */
  46      /** @defgroup XBT_log    Logging support */
  47      /** @defgroup XBT_error  Assert macro familly */
  48      /** @defgroup XBT_config Configuration support */
  49      /** @defgroup XBT_mallocator Mallocators */
  50 /** @} */
  51
  52
  53 ########################################################################
  54
  55 /** @addtogroup XBT_adt
  56
  57   Here are the basic data containers that every C programmer rewrites one day.
  58   You won't need to do so yourself, you lucky one, because we did it for you.
  59
  60   @{ */
  61      /** @defgroup XBT_dynar  Dynar: generic dynamic array */
  62      /** @defgroup XBT_dict   Dict: generic dictionnary */
  63      /** @defgroup XBT_set    Set: generic set datatype */
  64      /** @defgroup XBT_fifo   Fifo: generic workqueue */
  65      /** @defgroup XBT_swag   Swag: O(1) set datatype */
  66      /** @defgroup XBT_heap Heap: generic heap data structure */
  67 /** @} */
  68
  69
  70 ########################################################################
  71
  72 /** @addtogroup XBT_misc
  73
  74   Here are several general purposes library components designed specially
  75   for you, you lucky one.
  76
  77
  78   @{ */
  79      /** @defgroup XBT_graph General purpose graph library */
  80 /** @} */ End of XBT_misc
  81
  82 /* ************************* *
  83  * * PORTABILITY-INTERNALS * * (not included in documentation)
  84  * ************************* */
  85
  86  /** \defgroup XBT_context Portable context implementation
  87   *  \brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
  88   *  for non-preemptible threads.
  89   *
  90   *  You shouldn't use it directly since it is merely intended to ease the
  91   *  implementation of the several programmation environment of the
  92   *  SimGrid toolkit (namely, \ref MSG_API, \ref GRAS_API and \ref SMPI_API).
  93   *
  94   *  You should use those environments instead.
  95   */
  96