Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove the deprecated 'state' attribute from the doc
[simgrid.git] / doc / doxygen / module-xbt.doc
index 0673707..6a0c846 100644 (file)
@@ -2,28 +2,21 @@
 
    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_strbuff
-    - \ref XBT_misc
-      - \ref XBT_graph
+      - @ref XBT_dynar
+      - @ref XBT_dict
+    - @ref XBT_misc
+      - @ref XBT_graph
 
   @{ */
    /** @defgroup XBT_grounding   Grounding features */
@@ -45,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 */
 /** @} */
 
 
+
+
 ########################################################################
 
 /** @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 */
 /** @} */
 
 
@@ -83,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 */
  * * PORTABILITY-INTERNALS * * (not included in documentation)
  * ************************* */
 
- /** \addtogroup XBT_context Portable context implementation
-  *  \brief Contexts are a higher level system than <tt>setjump/longjmp</tt>
+ /** @addtogroup 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 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.
   */