X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/1ad19bb40f7e74d3fb3689982c36794866c645e3..d1d42edba2b125017c709f79ad20f40ea40fa981:/doc/doxygen/module-xbt.doc diff --git a/doc/doxygen/module-xbt.doc b/doc/doxygen/module-xbt.doc index 30df3723e7..6a0c84635b 100644 --- a/doc/doxygen/module-xbt.doc +++ b/doc/doxygen/module-xbt.doc @@ -2,32 +2,26 @@ The XBT functionalities fall into several categories: - Portability support - - \ref XBT_syscall - - \ref XBT_str - - \ref XBT_file + - @ref XBT_syscall + - @ref XBT_str - Grounding features - - \ref XBT_ex - - \ref XBT_log - - \ref XBT_error - - \ref XBT_config - - \ref XBT_mallocator - - \ref XBT_cunit + - @ref XBT_ex + - @ref XBT_ex_c + - @ref XBT_log + - @ref XBT_error + - @ref XBT_config + - @ref XBT_mallocator + - @ref XBT_cunit - 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 - - \ref XBT_peer - - \ref XBT_misc - - \ref XBT_graph + - @ref XBT_dynar + - @ref XBT_dict + - @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 */ + /** @defgroup XBT_misc Miscellaneous */ /** @} */ @@ -44,7 +38,8 @@ /** @defgroup XBT_syscall Malloc and friends */ /** @defgroup XBT_str String related functions */ - /** @defgroup XBT_ex Exception support */ + /** @defgroup XBT_ex Exception support (C++) */ + /** @defgroup XBT_ex_c Exception support (C) */ /** @defgroup XBT_log Logging support */ /** @defgroup XBT_error Assert macro familly */ /** @defgroup XBT_config Configuration support */ @@ -53,21 +48,20 @@ /** @} */ + + ######################################################################## /** @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. + However, if you are programming in C++ you might want to use C++ containers + instead. @{ */ /** @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 */ - /** @defgroup XBT_dd Data description */ /** @} */ @@ -82,8 +76,7 @@ @{ */ /** @defgroup XBT_graph General purpose graph library */ /** @defgroup XBT_parmap Parallel map */ - /** @defgroup XBT_peer Peer */ - /** @defgroup XBT_synchro Synchro stuff */ + /** @defgroup XBT_synchro Simulated Synchronization */ /** @defgroup XBT_thread Thread stuff */ /** @defgroup XBT_context Portable context implementation */ /** @defgroup XBT_replay Replay */ @@ -93,13 +86,13 @@ * * PORTABILITY-INTERNALS * * (not included in documentation) * ************************* */ - /** \addtogroup XBT_context Portable context implementation - * \brief Contexts are a higher level system than setjump/longjmp + /** @addtogroup XBT_context Portable context implementation + * @brief Contexts are a higher level system than setjump/longjmp * for non-preemptible threads. * * 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 and \ref SMPI_API). + * SimGrid toolkit (namely, @ref MSG_API and @ref SMPI_API). * * You should use those environments instead. */