X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/9b048ccf439b072f6a0be4e2352dc14a515a3ea6..3e0633f41cb1ab62db77bac6ad9bda9ee02ddd43:/doc/module-xbt.doc diff --git a/doc/module-xbt.doc b/doc/module-xbt.doc index 3619f7b17e..c7990deab3 100644 --- a/doc/module-xbt.doc +++ b/doc/module-xbt.doc @@ -6,6 +6,7 @@ * - Grounding features * - \ref XBT_ex * - \ref XBT_log + * - \ref XBT_error * - \ref XBT_config * - Data structures * - \ref XBT_dynar @@ -19,70 +20,22 @@ * @{ */ + /*PORTABILITY*/ + /** @defgroup XBT_syscall Malloc and friends */ -/* *************** * - * * PORTABILITY * * - * *************** */ + /*GROUNDING*/ + /** @defgroup XBT_ex Exception support */ + /** @defgroup XBT_log Logging support */ + /** @defgroup XBT_error Assert macro familly */ + /** @defgroup XBT_config Configuration support */ - /** @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) - * @{ - */ - - /** \defgroup XBT_log_cats Existing log categories - * \ingroup XBT_log - * \brief (automatically extracted) - * - * This is the list of all existing log categories in SimGrid. - * This list was automatically extracted from the source code by - * the src/xbt_log_extract_hierarchy utility. - * - * You can thus be certain that it is uptodate, but it may somehow - * lack a final manual touch. - * Anyway, nothing's perfect ;) - */ - - /** @} */ - - /** @defgroup XBT_config Configuration support - * @brief Changing the configuration of SimGrid components (grounding feature) - */ - -/* **************** * - * * DATA STRUCTS * * - * **************** */ - /** @defgroup XBT_dynar A generic dynamic array - * @brief DynArr are dynamically sized vector which may contain any type of variables. - */ - - /** @defgroup XBT_dict A generic dictionnary - * @brief The dictionnary data structure (comparable to hash tables) - */ - - /** \defgroup XBT_set A generic set datatype - * \brief A data container consisting in \ref XBT_dict and \ref XBT_dynar - */ - -/** \addtogroup XBT_fifo - \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 */ + /*DATA STRUCTS*/ + /** @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 */ /* ************************* * * * PORTABILITY-INTERNALS * * @@ -98,3 +51,5 @@ * * You should use those mechanism instead. */ + +/** @} */ End of XBT_API