X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f206ca050b853d202fd639352c5a0d400d06a825..e4ad10b76792651791deb2fcdb1540c490ef149e:/doc/module-xbt.doc diff --git a/doc/module-xbt.doc b/doc/module-xbt.doc index ea4659fd6d..8fc4e95b0f 100644 --- a/doc/module-xbt.doc +++ b/doc/module-xbt.doc @@ -20,16 +20,47 @@ * @{ */ - /*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 */ @@ -37,8 +68,26 @@ /** @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 @@ -52,4 +101,3 @@ * You should use those environments instead. */ -/** @} */ End of XBT_API