/** @addtogroup XBT_API
*
* The XBT functionalities fall into several categories:
- * - Portability support.
+ * - Portability support
* - \ref XBT_syscall
* - Grounding features
* - \ref XBT_ex
* @{
*/
- /*PORTABILITY*/
- /** @defgroup XBT_syscall Malloc and friends */
+ /** @defgroup XBT_grounding Grounding features */
+ /** @defgroup XBT_adt Usual data structures */
+ /** @defgroup XBT_misc Misc general purposes library components */
+
+/** @} */
- /*GROUNDING*/
+/*
+ * +++++++++++++
+ * + 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_ex Exception support */
/** @defgroup XBT_log Logging support */
/** @defgroup XBT_error Assert macro familly */
/** @defgroup XBT_config Configuration support */
- /*DATA STRUCTS*/
+/** @} */
+
+/*
+ * ++++++++++++++++
+ * + 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_swag Swag: O(1) set datatype */
/** @defgroup XBT_heap Heap: generic heap data structure */
+/** @} */ End of XBT_adt
+
+/*
+ * +++++++++++++++++
+ * + MISC FEATURES +
+ * +++++++++++++++++
+ */
+
+/** @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
* \brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
* for non-preemptible threads.
*
- * You shouldn't use it directly since it is merly intended to ease the
- * implementation of the serveral programmation environment of the
- * SimGrid toolkit (nammely, \ref MSG_API, \ref GRAS_API and \ref SMPI_API).
+ * You shouldn't use it directly since it is merely intended to ease the
+ * implementation of the several programmation environment of the
+ * SimGrid toolkit (namely, \ref MSG_API, \ref GRAS_API and \ref SMPI_API).
*
- * You should use those mechanism instead.
+ * You should use those environments instead.
*/
-/** @} */ End of XBT_API
