X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/818127c78194a2f3edfb8e26bd3ccadb136db6ac..739b9167d2003cf3c319a3fa2f11d6686e5b790d:/doc/module-xbt.doc?ds=sidebyside

diff --git a/doc/module-xbt.doc b/doc/module-xbt.doc
index d201641844..5946d976d2 100644
--- a/doc/module-xbt.doc
+++ b/doc/module-xbt.doc
@@ -1,8 +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
@@ -30,6 +32,10 @@
 /* ************* *
  * * 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)
      *  @{
@@ -50,12 +56,12 @@
 
     /** @} */
 
-
-    /** @defgroup XBT_error Error tracking support
-     *  @brief A set of macros easing the handling of errors (grounding feature)
+    /** @defgroup XBT_error Assert macro familly
+     *  @brief Those are the GRAS version of the good ol' assert macro. You can pass them a format message and 
+     * arguments, just as if it where a printf. It is converted to a CRITICALn logging request.
      */
 
-    /** @defgroup XBT_config Configuration support
+   /** @defgroup XBT_config Configuration support
      *  @brief Changing the configuration of SimGrid components (grounding feature)
      */
 
@@ -74,10 +80,16 @@
      * \brief A data container consisting in \ref XBT_dict and \ref XBT_dynar
      */
     
-/**       \addtogroup XBT_fifo
-          \ingroup XBT_API */
-/**        \addtogroup XBT_swag
-          \ingroup XBT_API */
+    /** \defgroup XBT_fifo A generic workqueue
+      *  \brief This section describes the API to generic workqueue. These functions
+      *   provide the same kind of functionnality as dynamic arrays but in time O(1). 
+      *   However these functions use malloc/free way too much often.
+      */
+	  
+    /** @defgroup XBT_swag A O(1) set datatype
+     *  @brief a O(1) set based on linked lists
+     */
+	  
 /**       \addtogroup XBT_heap
           \ingroup XBT_API */
 
@@ -93,5 +105,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.
   */