doc/doxygen/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_ex_c
  10       - @ref XBT_log
  11       - @ref XBT_error
  12       - @ref XBT_config
  13       - @ref XBT_mallocator
  14       - @ref XBT_cunit
  15     - Data structures
  16       - @ref XBT_dynar
  17       - @ref XBT_dict
  18     - @ref XBT_misc
  19       - @ref XBT_graph
  20
  21   @{ */
  22    /** @defgroup XBT_grounding   Grounding features */
  23    /** @defgroup XBT_adt         Usual data structures */
  24    /** @defgroup XBT_misc        Miscellaneous */
  25 /** @} */
  26
  27
  28 ########################################################################
  29
  30
  31 /** @addtogroup XBT_grounding
  32
  33   Grounding features are the basement of SimGrid. You'll find portable (and
  34   secure) wrappers to the malloc-like functions, logging support, error
  35   reporting features, etc.
  36
  37   @{ */
  38
  39      /** @defgroup XBT_syscall Malloc and friends */
  40      /** @defgroup XBT_str     String related functions */
  41      /** @defgroup XBT_ex     Exception support (C++) */
  42      /** @defgroup XBT_ex_c   Exception support (C)   */
  43      /** @defgroup XBT_log    Logging support */
  44      /** @defgroup XBT_error  Assert macro familly */
  45      /** @defgroup XBT_config Configuration support */
  46      /** @defgroup XBT_mallocator Mallocators */
  47      /** @defgroup XBT_cunit      Unit testing support */
  48 /** @} */
  49
  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   However, if you are programming in C++ you might want to use C++ containers
  60   instead.
  61
  62   @{ */
  63      /** @defgroup XBT_dynar  Dynar: generic dynamic array */
  64      /** @defgroup XBT_dict   Dict: generic dictionnary */
  65 /** @} */
  66
  67
  68 ########################################################################
  69
  70 /** @addtogroup XBT_misc
  71
  72   Here are several general purposes library components designed specially
  73   for you, you lucky one.
  74
  75
  76   @{ */
  77      /** @defgroup XBT_graph General purpose graph library */
  78      /** @defgroup XBT_parmap Parallel map */
  79      /** @defgroup XBT_synchro Simulated Synchronization */
  80      /** @defgroup XBT_context Portable context implementation */
  81      /** @defgroup XBT_replay Replay */
  82 /** @} */
  83
  84 /* ************************* *
  85  * * PORTABILITY-INTERNALS * * (not included in documentation)
  86  * ************************* */
  87
  88  /** @addtogroup XBT_context Portable context implementation
  89   *  @brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
  90   *  for non-preemptible threads.
  91   *
  92   *  You shouldn't use it directly since it is merely intended to ease the
  93   *  implementation of the several programmation environment of the
  94   *  SimGrid toolkit (namely, @ref MSG_API and @ref SMPI_API).
  95   *
  96   *  You should use those environments instead.
  97   */
  98