X-Git-Url: https://git.liburcu.org/?p=urcu.git;a=blobdiff_plain;f=urcu%2Fwfcqueue.h;h=4ce8fe962296406b7b69eb75992ea9d910ef6f08;hp=d9ec5349d7be203da7f80f6e6c0de5cda96e20e9;hb=ffa11a1830c532f3b052146eb9f0dd450cb2a0f2;hpb=f878b49ebb78010f4f9466d3512a7e88787812b2

diff --git a/urcu/wfcqueue.h b/urcu/wfcqueue.h
index d9ec534..4ce8fe9 100644
--- a/urcu/wfcqueue.h
+++ b/urcu/wfcqueue.h
@@ -192,7 +192,7 @@ extern bool cds_wfcq_enqueue(struct cds_wfcq_head *head,
  * Content written into the node before enqueue is guaranteed to be
  * consistent, but no other memory ordering is ensured.
  * It is valid to reuse and free a dequeued node immediately.
- * Mutual exlusion with cds_wfcq_dequeue_blocking and dequeue lock is
+ * Mutual exclusion with cds_wfcq_dequeue_blocking and dequeue lock is
  * ensured.
  */
 extern struct cds_wfcq_node *cds_wfcq_dequeue_blocking(
@@ -206,7 +206,7 @@ extern struct cds_wfcq_node *cds_wfcq_dequeue_blocking(
  * dest_q must be already initialized.
  * Content written into the node before enqueue is guaranteed to be
  * consistent, but no other memory ordering is ensured.
- * Mutual exlusion with cds_wfcq_dequeue_blocking and dequeue lock is
+ * Mutual exclusion with cds_wfcq_dequeue_blocking and dequeue lock is
  * ensured.
  *
  * Returns enum cds_wfcq_ret which indicates the state of the src or
@@ -280,6 +280,8 @@ extern enum cds_wfcq_ret __cds_wfcq_splice_nonblocking(
  * Used by for-like iteration macros:
  * __cds_wfcq_for_each_blocking()
  * __cds_wfcq_for_each_blocking_safe()
+ *
+ * Returns NULL if queue is empty, first node otherwise.
  */
 extern struct cds_wfcq_node *__cds_wfcq_first_blocking(
 		struct cds_wfcq_head *head,
@@ -306,6 +308,9 @@ extern struct cds_wfcq_node *__cds_wfcq_first_nonblocking(
  * Used by for-like iteration macros:
  * __cds_wfcq_for_each_blocking()
  * __cds_wfcq_for_each_blocking_safe()
+ *
+ * Returns NULL if reached end of queue, non-NULL next queue node
+ * otherwise.
  */
 extern struct cds_wfcq_node *__cds_wfcq_next_blocking(
 		struct cds_wfcq_head *head,