From: mquinson <mquinson@48e7efb5-ca39-0410-a469-dd3cf9ba447f>
Date: Sun, 13 Feb 2005 16:04:23 +0000 (+0000)
Subject: doxygenification of xbt
X-Git-Tag: v3.3~4362
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/6520d7ebe2834ee2e913745a9e9043aa6169427d

doxygenification of xbt


git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@989 48e7efb5-ca39-0410-a469-dd3cf9ba447f
---

diff --git a/doc/Doxyfile.API.in b/doc/Doxyfile.API.in
index 750ccb497c..06c24578f8 100644
--- a/doc/Doxyfile.API.in
+++ b/doc/Doxyfile.API.in
@@ -449,7 +449,8 @@ EXCLUDE_PATTERNS       =
 # the \include command).
 
 EXAMPLE_PATH           = @top_srcdir@/src/surf/ \
-                         @top_srcdir@/examples
+                         @top_srcdir@/examples \
+                         @top_srcdir@/testsuite
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
diff --git a/doc/index.doc b/doc/index.doc
index 81e00b3404..443d1aed5b 100644
--- a/doc/index.doc
+++ b/doc/index.doc
@@ -68,9 +68,9 @@ The basement of the whole toolkit is constituted by the <b>\ref XBT_API
 (eXtended Bundle of Tools)</b>.
 
 It is a portable library providing some grounding features such as \ref
-XBT_log and \ref XBT_error. XBT also encompass the following convenient
-datastructures: \ref XBT_dynar, \ref XBT_fifo, \ref XBT_dict, \ref XBT_heap,
-\ref XBT_set and \ref XBT_swag.
+XBT_log, \ref XBT_error and \ref XBT_config. XBT also encompass the
+following convenient datastructures: \ref XBT_dynar, \ref XBT_fifo, \ref
+XBT_dict, \ref XBT_heap, \ref XBT_set and \ref XBT_swag.
 
 See the \ref XBT_API section for more details.
 
diff --git a/doc/module-xbt.doc b/doc/module-xbt.doc
new file mode 100644
index 0000000000..e5bac1b400
--- /dev/null
+++ b/doc/module-xbt.doc
@@ -0,0 +1,91 @@
+/** @addtogroup XBT_API
+ *
+ *   - Grounding features
+ *     - \ref XBT_log
+ *     - \ref XBT_error
+ *     - \ref XBT_config
+ *   - 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
+ *   - 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
+ *
+ *  @{
+ */
+
+/* ************* *
+ * * GROUNDING * *
+ * ************* */
+    /** @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 */
+/**        \addtogroup XBT_swag
+          \ingroup XBT_API */
+/**       \addtogroup XBT_heap
+          \ingroup XBT_API */
+
+/* *************** *
+ * * PORTABILITY * *
+ * *************** */
+
+ /** \defgroup XBT_context Portable context implementation
+  *  \brief Contexts are a higher level system than <tt>setjump/longjmp</tt> 
+  *  for non-preemptible threads.
+  *
+  *  You shouldn't use it directly since it is merly intended to ease the 
+  *  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.
+  */