X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/da7e15623cc3e43bd5b30848b1b2283af9470b5c..c41f6db03c1da0871287a5b70f919ab44278d938:/include/xbt/fifo.h?ds=sidebyside
diff --git a/include/xbt/fifo.h b/include/xbt/fifo.h
index 01dfbff770..46becae17e 100644
--- a/include/xbt/fifo.h
+++ b/include/xbt/fifo.h
@@ -7,14 +7,28 @@
#ifndef _XBT_FIFO_H
#define _XBT_FIFO_H
-#include "xbt/misc.h" /* BEGIN_DECL */
+#include "xbt/misc.h" /* SG_BEGIN_DECL */
-BEGIN_DECL()
+SG_BEGIN_DECL()
-/** \addtogroup XBT_fifo
- * @{ */
+/** @addtogroup XBT_fifo
+ * @brief This section describes the API to generic workqueue.
+ *
+ *
Top | [\ref index]::[\ref XBT_API]
+ * |
Prev | [\ref XBT_set]
+ * |
Next | [\ref XBT_swag]
+ * |
Down | [\ref XBT_fifo_cons] |
+ *
+ * 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.
+ */
-/** @name 1. Constructor/destructor
+/** @defgroup XBT_fifo_cons Fifo constructor and destructor
+ * @ingroup XBT_fifo
+ *
+ * Top | [\ref index]::[\ref XBT_API]::[\ref XBT_fifo]
+ * |
Prev |
+ * |
Next | [\ref XBT_fifo_perl] |
* @{
*/
@@ -30,7 +44,12 @@ xbt_fifo_t xbt_fifo_new(void);
void xbt_fifo_free(xbt_fifo_t);
/** @} */
-/** @name 2. Perl-like functions
+/** @defgroup XBT_fifo_perl Fifo perl-like functions
+ * @ingroup XBT_fifo
+ *
+ * Top | [\ref index]::[\ref XBT_API]::[\ref XBT_fifo]
+ * |
Prev | [\ref XBT_fifo_cons]
+ * |
Next | [\ref XBT_fifo_direct] |
* @{
*/
xbt_fifo_item_t xbt_fifo_push(xbt_fifo_t, void *);
@@ -41,7 +60,12 @@ int xbt_fifo_size(xbt_fifo_t);
int xbt_fifo_is_in(xbt_fifo_t, void *);
/** @} */
-/** @name 3. Manipulating items directly
+/** @defgroup XBT_fifo_direct Direct access to fifo elements
+ * @ingroup XBT_fifo
+ *
+ * Top | [\ref index]::[\ref XBT_API]::[\ref XBT_fifo]
+ * |
Prev | [\ref XBT_fifo_perl]
+ * |
Next | [\ref XBT_fifo_misc] |
*
* @{
*/
@@ -70,6 +94,7 @@ xbt_fifo_item_t xbt_fifo_get_prev_item(xbt_fifo_item_t i);
* \param i a bucket (#xbt_fifo_item_t)
* \param type a type
* \param n an object of type \a type.
+ * @hideinitializer
*
* Iterates over the whole list.
*/
@@ -80,7 +105,12 @@ xbt_fifo_item_t xbt_fifo_get_prev_item(xbt_fifo_item_t i);
/** @} */
-/** @name 4. Miscanaleous
+/** @defgroup XBT_fifo_misc Misc fifo functions
+ * @ingroup XBT_fifo
+ *
+ * Top | [\ref index]::[\ref XBT_API]::[\ref XBT_fifo]
+ * |
Prev | [\ref XBT_fifo_direct]
+ * |
Next | |
*
* @{
*/
@@ -88,19 +118,16 @@ void **xbt_fifo_to_array(xbt_fifo_t);
xbt_fifo_t xbt_fifo_copy(xbt_fifo_t);
/** @} */
-/** @name 5. Deprecated functions: don't use!
- *
- * @{
- */
+/* Deprecated functions: don't use! */
xbt_fifo_item_t xbt_fifo_newitem(void);
void xbt_fifo_freeitem(xbt_fifo_item_t);
xbt_fifo_item_t xbt_fifo_getFirstItem(xbt_fifo_t l);
xbt_fifo_item_t xbt_fifo_getNextItem(xbt_fifo_item_t i);
xbt_fifo_item_t xbt_fifo_getPrevItem(xbt_fifo_item_t i);
-/** @} */
-END_DECL()
-/** @} */
+SG_END_DECL()
+
+
#endif /* _XBT_FIFO_H */