1 /** @addtogroup XBT_API
3 The XBT functionalities fall into several categories:
23 /** @defgroup XBT_grounding Grounding features */
24 /** @defgroup XBT_adt Usual data structures */
25 /** @defgroup XBT_misc Miscellaneous */
29 ########################################################################
32 /** @addtogroup XBT_grounding
34 Grounding features are the basement of SimGrid. You'll find portable (and
35 secure) wrappers to the malloc-like functions, logging support, error
36 reporting features, etc.
40 /** @defgroup XBT_syscall Malloc and friends */
41 /** @defgroup XBT_str String related functions */
42 /** @defgroup XBT_ex Exception support (C++) */
43 /** @defgroup XBT_ex_c Exception support (C) */
44 /** @defgroup XBT_log Logging support */
45 /** @defgroup XBT_error Assert macro familly */
46 /** @defgroup XBT_config Configuration support */
47 /** @defgroup XBT_mallocator Mallocators */
48 /** @defgroup XBT_cunit Unit testing support */
54 ########################################################################
56 /** @addtogroup XBT_adt
58 Here are the basic data containers that every C programmer rewrites one day.
59 You won't need to do so yourself, you lucky one, because we did it for you.
60 However, if you are programming in C++ you might want to use C++ containers
64 /** @defgroup XBT_dynar Dynar: generic dynamic array */
65 /** @defgroup XBT_dict Dict: generic dictionnary */
69 ########################################################################
71 /** @addtogroup XBT_misc
73 Here are several general purposes library components designed specially
74 for you, you lucky one.
78 /** @defgroup XBT_graph General purpose graph library */
79 /** @defgroup XBT_parmap Parallel map */
80 /** @defgroup XBT_synchro Simulated Synchronization */
81 /** @defgroup XBT_thread Thread stuff */
82 /** @defgroup XBT_context Portable context implementation */
83 /** @defgroup XBT_replay Replay */
86 /* ************************* *
87 * * PORTABILITY-INTERNALS * * (not included in documentation)
88 * ************************* */
90 /** \addtogroup XBT_context Portable context implementation
91 * \brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
92 * for non-preemptible threads.
94 * You shouldn't use it directly since it is merely intended to ease the
95 * implementation of the several programmation environment of the
96 * SimGrid toolkit (namely, \ref MSG_API and \ref SMPI_API).
98 * You should use those environments instead.