1 /** @addtogroup XBT_API
3 The XBT functionalities fall into several categories:
22 /** @defgroup XBT_grounding Grounding features */
23 /** @defgroup XBT_adt Usual data structures */
24 /** @defgroup XBT_misc Miscellaneous */
28 ########################################################################
31 /** @addtogroup XBT_grounding
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.
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 */
53 ########################################################################
55 /** @addtogroup XBT_adt
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
63 /** @defgroup XBT_dynar Dynar: generic dynamic array */
64 /** @defgroup XBT_dict Dict: generic dictionnary */
68 ########################################################################
70 /** @addtogroup XBT_misc
72 Here are several general purposes library components designed specially
73 for you, you lucky one.
77 /** @defgroup XBT_graph General purpose graph library */
78 /** @defgroup XBT_parmap Parallel map */
79 /** @defgroup XBT_synchro Simulated Synchronization */
80 /** @defgroup XBT_thread Thread stuff */
81 /** @defgroup XBT_context Portable context implementation */
82 /** @defgroup XBT_replay Replay */
85 /* ************************* *
86 * * PORTABILITY-INTERNALS * * (not included in documentation)
87 * ************************* */
89 /** \addtogroup XBT_context Portable context implementation
90 * \brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
91 * for non-preemptible threads.
93 * You shouldn't use it directly since it is merely intended to ease the
94 * implementation of the several programmation environment of the
95 * SimGrid toolkit (namely, \ref MSG_API and \ref SMPI_API).
97 * You should use those environments instead.