wfstack: document first/next return values

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>

diff --git a/urcu/static/wfstack.h b/urcu/static/wfstack.h
index 24f6cb478447e76ec0be88b6a86beb28b129e83c..1a0e4d7475bab6beca8ecf3dba2b242b88ae6634 100644 (file)
--- a/urcu/static/wfstack.h
+++ b/urcu/static/wfstack.h
@@ -291,6 +291,8 @@ _cds_wfs_pop_all_blocking(struct cds_wfs_stack *s)
  * Used by for-like iteration macros in urcu/wfstack.h:
  * cds_wfs_for_each_blocking()
  * cds_wfs_for_each_blocking_safe()
+ *
+ * Returns NULL if popped stack is empty, top stack node otherwise.
  */
 static inline struct cds_wfs_node *
 _cds_wfs_first_blocking(struct cds_wfs_head *head)
@@ -309,6 +311,9 @@ _cds_wfs_first_blocking(struct cds_wfs_head *head)
  * Used by for-like iteration macros in urcu/wfstack.h:
  * cds_wfs_for_each_blocking()
  * cds_wfs_for_each_blocking_safe()
+ *
+ * Returns NULL if reached end of popped stack, non-NULL next stack
+ * node otherwise.
  */
 static inline struct cds_wfs_node *
 _cds_wfs_next_blocking(struct cds_wfs_node *node)

diff --git a/urcu/wfstack.h b/urcu/wfstack.h
index aa10881506a5ad2609cb62a39b18ee916e1676d2..20d1882c867b979910ad6000b8c3b64a8879a0c7 100644 (file)
--- a/urcu/wfstack.h
+++ b/urcu/wfstack.h
@@ -162,6 +162,8 @@ extern struct cds_wfs_head *cds_wfs_pop_all_blocking(struct cds_wfs_stack *s);
  * Used by for-like iteration macros in urcu/wfstack.h:
  * cds_wfs_for_each_blocking()
  * cds_wfs_for_each_blocking_safe()
+ *
+ * Returns NULL if popped stack is empty, top stack node otherwise.
  */
 extern struct cds_wfs_node *cds_wfs_first_blocking(struct cds_wfs_head *head);
 
@@ -174,6 +176,9 @@ extern struct cds_wfs_node *cds_wfs_first_blocking(struct cds_wfs_head *head);
  * Used by for-like iteration macros in urcu/wfstack.h:
  * cds_wfs_for_each_blocking()
  * cds_wfs_for_each_blocking_safe()
+ *
+ * Returns NULL if reached end of popped stack, non-NULL next stack
+ * node otherwise.
  */
 extern struct cds_wfs_node *cds_wfs_next_blocking(struct cds_wfs_node *node);