diff options
Diffstat (limited to 'include/bh/queue.h')
| -rw-r--r-- | include/bh/queue.h | 13 |
1 files changed, 5 insertions, 8 deletions
diff --git a/include/bh/queue.h b/include/bh/queue.h index c5185ef..d25af65 100644 --- a/include/bh/queue.h +++ b/include/bh/queue.h @@ -1,7 +1,7 @@ #ifndef BH_QUEUE_H #define BH_QUEUE_H -#include <bh/bh.h> +#include "bh.h" typedef struct bh_queue_s bh_queue_t; @@ -30,7 +30,7 @@ void bh_queue_free(bh_queue_t *queue); * * @param queue Valid pointer to the queue object. * - * @warning Clearing the queue does invalidate iterators. + * @warning Calling this function will invalidate iterators. * * @sa bh_queue_remove */ @@ -45,7 +45,7 @@ void bh_queue_clear(bh_queue_t *queue); * @return If the function succeeds, the return value is zero. * @return If the function fails, the return value is non-zero. * - * @warning Reserving queue space does invalidate iterators. + * @warning Calling this function will invalidate iterators. * * @sa bh_queue_capacity, bh_queue_insert */ @@ -62,7 +62,7 @@ int bh_queue_reserve(bh_queue_t *queue, * @return If the function fails, the return value is non-zero. * * @warning Inserted element is owned by the caller of the function. - * @warning Inserting elements into the queue does invalidate iterators. + * @warning Calling this function will invalidate iterators. * * @sa bh_queue_remove, bh_queue_front */ @@ -74,7 +74,7 @@ int bh_queue_insert(bh_queue_t *queue, * * @param queue Valid pointer to the queue object. * - * @warning Removing elements from the queue does invalidate iterators. + * @warning Calling this function will invalidate iterators. * * @sa bh_queue_insert, bh_queue_front */ @@ -89,9 +89,6 @@ void bh_queue_remove(bh_queue_t *queue); * the element. * @return If the function fails, the return value is NULL. * - * @note If the queue is empty, function will fail to return element from - * the queue. - * * @sa bh_queue_empty, bh_queue_insert */ void *bh_queue_front(bh_queue_t *queue); |