document exceptions

[simgrid.git] / src / xbt / fifo.c

diff --git a/src/xbt/fifo.c b/src/xbt/fifo.c
index e0c4121..f282a6e 100644 (file)
--- a/src/xbt/fifo.c
+++ b/src/xbt/fifo.c
@@ -11,10 +11,16 @@
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(fifo,xbt,"FIFO");
 
+/** \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 a way too much often.
+  */
+
 /** \name Functions 
  *  \ingroup XBT_fifo
  */
-/*@{*/
+/* @{ */
 
 /** Constructor
  * \return a new fifo
@@ -388,6 +394,6 @@ xbt_fifo_item_t xbt_fifo_getPrevItem(xbt_fifo_item_t i)
   if(i) return i->prev;
   return NULL;
 }
-/*@}*/
+/* @} */