Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Rename testsuite to cunit (more sexy name); integrate it properly into SimGrid; use...
[simgrid.git] / doc / module-xbt.doc
index d5b6c53..c7990de 100644 (file)
  *  @{
  */
 
-
-/* *************** *
- * * 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)
-     *  @{
-     */
-
-       /** \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_error Error tracking support
-     *  @brief A set of macros easing the handling of errors (grounding feature)
-     */
-
-    /** @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 */
+  /*PORTABILITY*/
+     /** @defgroup XBT_syscall Malloc and friends */
+
+  /*GROUNDING*/
+     /** @defgroup XBT_ex     Exception support */
+     /** @defgroup XBT_log    Logging support */
+     /** @defgroup XBT_error  Assert macro familly */
+     /** @defgroup XBT_config Configuration support */
+
+  /*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 * *
   *
   *  You should use those mechanism instead.
   */
+
+/** @} */ End of XBT_API