Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Improve a bit the documentation of hte xbt_queues, and ensure that they are displayed...
authorMartin Quinson <martin.quinson@loria.fr>
Fri, 11 Nov 2011 01:37:58 +0000 (02:37 +0100)
committerMartin Quinson <martin.quinson@loria.fr>
Fri, 11 Nov 2011 01:37:58 +0000 (02:37 +0100)
doc/module-xbt.doc
include/xbt/queue.h

index c2ab8c8..a874b52 100644 (file)
@@ -16,6 +16,7 @@
       - \ref XBT_set 
         Data are associated to both an ID (0(1) search) and a name
       - \ref XBT_fifo
+      - \ref XBT_queue
       - \ref XBT_swag
       - \ref XBT_heap
     - \ref XBT_misc
index 9084a5c..3b83e7f 100644 (file)
 SG_BEGIN_DECL()
 
 /** @addtogroup XBT_queue
-  * @brief Synchronized message exchanging queue.
+  * \brief Synchronized message exchanging queue.
   *
-  * These is the classical producer/consumer synchronization scheme, which all concurrent programmer recode one day or another.
+  * These is the classical producer/consumer synchronization scheme, 
+  * which all concurrent programmer recode one day or another.
+  *
+  * The good thing of this implementation is that it works seamlessly
+  * in your universe. When using one of the classical simulation
+  * interface (such as MSG), it achieves the synchronization on top
+  * of the simulator. If you use instead the real life implementation
+  * comming with GRAS, it uses the synchronization of your OS
+  * (whatever could it be). The choice is done at link time.
   *  
   * For performance concerns, the content of queue must be homogeneous, 
-  * just like dynars (see the \ref XBT_dynar section). Indeed, queues use a 
+  * just like dynars (see the \ref XBT_dynar section). Actually, queues use a 
   * dynar to store the data, and add the synchronization on top of it. 
   * 
   * @{