X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/6520d7ebe2834ee2e913745a9e9043aa6169427d..79e5adfad7b797250155cd0726a2f0930008af46:/doc/module-xbt.doc diff --git a/doc/module-xbt.doc b/doc/module-xbt.doc index e5bac1b400..d5b6c53f36 100644 --- a/doc/module-xbt.doc +++ b/doc/module-xbt.doc @@ -1,6 +1,10 @@ /** @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 @@ -12,18 +16,26 @@ * - \ref XBT_fifo * - \ref XBT_swag * - \ref XBT_heap - * - Portability support. The targeted audiance of this portability support - * is merly the programming environments (\ref MSG_API, \ref GRAS_API and - * \ref SMPI_API), not the user code which should get its portability from - * the used programming environment. - * - \ref XBT_context * * @{ */ + +/* *************** * + * * PORTABILITY * * + * *************** */ + + /** @defgroup XBT_syscall Malloc and friends + * @brief malloc and associated functions, killing the program on error + */ + /* ************* * * * GROUNDING * * * ************* */ + /** @defgroup XBT_ex Exception support + * @brief A set of macros providing exception a la C++ in ANSI C (grounding feature) + */ + /** @defgroup XBT_log Logging support * @brief A generic logging facility in the spirit of log4j (grounding feature) * @{ @@ -70,14 +82,17 @@ /** \addtogroup XBT_fifo \ingroup XBT_API */ -/** \addtogroup XBT_swag - \ingroup XBT_API */ + + /** @defgroup XBT_swag A O(1) set datatype + * @brief a O(1) set based on linked lists + */ + /** \addtogroup XBT_heap \ingroup XBT_API */ -/* *************** * - * * PORTABILITY * * - * *************** */ +/* ************************* * + * * PORTABILITY-INTERNALS * * + * ************************* */ /** \defgroup XBT_context Portable context implementation * \brief Contexts are a higher level system than setjump/longjmp @@ -87,5 +102,5 @@ * implementation of the serveral programmation environment of the * SimGrid toolkit (nammely, \ref MSG_API, \ref GRAS_API and \ref SMPI_API). * - * You should use those mecanism instead. + * You should use those mechanism instead. */