/** @addtogroup XBT_API
- *
- * The XBT functionalities fall into several categories:
- * - Portability support
- * - \ref XBT_syscall
- * - Grounding features
- * - \ref XBT_ex
- * - \ref XBT_log
- * - \ref XBT_error
- * - \ref XBT_config
- * - Data structures
- * - \ref XBT_dynar
- * - \ref XBT_dict
- * - \ref XBT_set
- * Data are associated to both an ID (0(1) search) and a name
- * - \ref XBT_fifo
- * - \ref XBT_swag
- * - \ref XBT_heap
- *
- * @{
- */
-
- /*PORTABILITY*/
- /** @defgroup XBT_syscall Malloc and friends */
+
+ The XBT functionalities fall into several categories:
+ - Portability support
+ - \ref XBT_syscall
+ - \ref XBT_str
+ - Grounding features
+ - \ref XBT_ex
+ - \ref XBT_log
+ - \ref XBT_error
+ - \ref XBT_config
+ - \ref XBT_mallocator
+ - Data structures
+ - \ref XBT_dynar
+ - \ref XBT_dict
+ - \ref XBT_set
+ Data are associated to both an ID (0(1) search) and a name
+ - \ref XBT_fifo
+ - \ref XBT_queue
+ - \ref XBT_swag
+ - \ref XBT_heap
+ - \ref XBT_peer
+ - \ref XBT_misc
+ - \ref XBT_graph
+
+ @{ */
+ /** @defgroup XBT_grounding Grounding features */
+ /** @defgroup XBT_adt Usual data structures */
+ /** @defgroup XBT_misc Misc general purposes library components */
+/** @} */
+
+
+########################################################################
- /*GROUNDING*/
+
+/** @addtogroup XBT_grounding
+
+ Grounding features are the basement of SimGrid. You'll find portable (and
+ secure) wrappers to the malloc-like functions, logging support, error
+ reporting features, etc.
+
+ @{ */
+
+ /** @defgroup XBT_syscall Malloc and friends */
+ /** @defgroup XBT_str String related functions */
/** @defgroup XBT_ex Exception support */
/** @defgroup XBT_log Logging support */
/** @defgroup XBT_error Assert macro familly */
/** @defgroup XBT_config Configuration support */
+ /** @defgroup XBT_mallocator Mallocators */
+/** @} */
- /*DATA STRUCTS*/
+
+########################################################################
+
+/** @addtogroup XBT_adt
+
+ Here are the basic data containers that every C programmer rewrites one day.
+ You won't need to do so yourself, you lucky one, because we did it for you.
+
+ @{ */
/** @defgroup XBT_dynar Dynar: generic dynamic array */
/** @defgroup XBT_dict Dict: generic dictionnary */
/** @defgroup XBT_set Set: generic set datatype */
/** @defgroup XBT_fifo Fifo: generic workqueue */
/** @defgroup XBT_swag Swag: O(1) set datatype */
/** @defgroup XBT_heap Heap: generic heap data structure */
+/** @} */
+
+
+########################################################################
+
+/** @addtogroup XBT_misc
+
+ Here are several general purposes library components designed specially
+ for you, you lucky one.
+
+
+ @{ */
+ /** @defgroup XBT_graph General purpose graph library */
+/** @} */ End of XBT_misc
/* ************************* *
- * * PORTABILITY-INTERNALS * *
+ * * PORTABILITY-INTERNALS * * (not included in documentation)
* ************************* */
/** \defgroup XBT_context Portable context implementation
* You should use those environments instead.
*/
-/** @} */ End of XBT_API