From: Duco van Amstel <duco.van.amstel@ens-lyon.org>
Date: Sun, 20 May 2012 11:23:23 +0000 (+0200)
Subject: A few more details in some functions descriptions
X-Git-Tag: v3_7_1~80
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/09485e6da95ca527e457bfe395a5175550dbfc06

A few more details in some functions descriptions
---

diff --git a/src/xbt/fifo.c b/src/xbt/fifo.c
index 57e0912f26..305abed358 100644
--- a/src/xbt/fifo.c
+++ b/src/xbt/fifo.c
@@ -450,6 +450,8 @@ XBT_INLINE int xbt_fifo_size(xbt_fifo_t f)
 /**
  * \param l a list
  * \return the head of \a l.
+ *
+ * Returns NULL if the list is empty.
  */
 XBT_INLINE xbt_fifo_item_t xbt_fifo_get_first_item(xbt_fifo_t l)
 {
@@ -459,6 +461,8 @@ XBT_INLINE xbt_fifo_item_t xbt_fifo_get_first_item(xbt_fifo_t l)
 /**
  * \param l a list
  * \return the tail of \a l.
+ *
+ * Returns NULL if the list is empty.
  */
 XBT_INLINE xbt_fifo_item_t xbt_fifo_get_last_item(xbt_fifo_t l)
 {
@@ -476,6 +480,8 @@ XBT_INLINE xbt_fifo_item_t xbt_fifo_getFirstItem(xbt_fifo_t l)
 /**
  * \param i a bucket
  * \return the bucket that comes next
+ *
+ * Returns NULL if \a i is the tail of the list.
  */
 XBT_INLINE xbt_fifo_item_t xbt_fifo_get_next_item(xbt_fifo_item_t i)
 {
@@ -495,6 +501,8 @@ xbt_fifo_item_t xbt_fifo_getNextItem(xbt_fifo_item_t i)
 /**
  * \param i a bucket
  * \return the bucket that is just before \a i.
+ *
+ * Returns NULL if \a i is the head of the list.
  */
 XBT_INLINE xbt_fifo_item_t xbt_fifo_get_prev_item(xbt_fifo_item_t i)
 {