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     - Data structures
  15       - @ref XBT_dynar
  16       - @ref XBT_dict
  17     - @ref XBT_misc
  18       - @ref XBT_graph
  19
  20   @{ */
  21    /** @defgroup XBT_grounding   Grounding features */
  22    /** @defgroup XBT_adt         Usual data structures */
  23    /** @defgroup XBT_misc        Miscellaneous */
  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_str     String related functions */
  40      /** @defgroup XBT_ex     Exception support (C++) */
  41      /** @defgroup XBT_ex_c   Exception support (C)   */
  42      /** @defgroup XBT_log    Logging support */
  43      /** @defgroup XBT_error  Assert macro familly */
  44      /** @defgroup XBT_config Configuration support */
  45      /** @defgroup XBT_mallocator Mallocators */
  46 /** @} */
  47
  48
  49
  50
  51 ########################################################################
  52
  53 /** @addtogroup XBT_adt
  54
  55   Here are the basic data containers that every C programmer rewrites one day.
  56   You won't need to do so yourself, you lucky one, because we did it for you.
  57   However, if you are programming in C++ you might want to use C++ containers
  58   instead.
  59
  60   @{ */
  61      /** @defgroup XBT_dynar  Dynar: generic dynamic array */
  62      /** @defgroup XBT_dict   Dict: generic dictionnary */
  63 /** @} */
  64
  65
  66 ########################################################################
  67
  68 /** @addtogroup XBT_misc
  69
  70   Here are several general purposes library components designed specially
  71   for you, you lucky one.
  72
  73
  74   @{ */
  75      /** @defgroup XBT_graph General purpose graph library */
  76      /** @defgroup XBT_parmap Parallel map */
  77      /** @defgroup XBT_synchro Simulated Synchronization */
  78      /** @defgroup XBT_context Portable context implementation */
  79      /** @defgroup XBT_replay Replay */
  80 /** @} */
  81
  82 /* ************************* *
  83  * * PORTABILITY-INTERNALS * * (not included in documentation)
  84  * ************************* */
  85
  86  /** @addtogroup 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 and @ref SMPI_API).
  93   *
  94   *  You should use those environments instead.
  95   */
  96