X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/6520d7ebe2834ee2e913745a9e9043aa6169427d..00e10260c18a854d25ebf608ab62f3b59e262a61:/doc/module-xbt.doc

diff --git a/doc/module-xbt.doc b/doc/module-xbt.doc
index e5bac1b400..da1989c45a 100644
--- a/doc/module-xbt.doc
+++ b/doc/module-xbt.doc
@@ -1,8 +1,11 @@
 /** @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
  *   - Data structures
  *     - \ref XBT_dynar 
@@ -12,18 +15,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)
      *  @{
@@ -44,11 +55,6 @@
 
     /** @} */
 
-
-    /** @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)
      */
@@ -68,16 +74,22 @@
      * \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 */
 
-/* *************** *
- * * PORTABILITY * *
- * *************** */
+/* ************************* *
+ * * PORTABILITY-INTERNALS * *
+ * ************************* */
 
  /** \defgroup XBT_context Portable context implementation
   *  \brief Contexts are a higher level system than <tt>setjump/longjmp</tt> 
@@ -87,5 +99,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.
   */