X-Git-Url: https://git.lttng.org/?p=urcu.git;a=blobdiff_plain;f=urcu%2Fstatic%2Fwfstack.h;fp=urcu%2Fstatic%2Fwfstack.h;h=1a0e4d7475bab6beca8ecf3dba2b242b88ae6634;hp=24f6cb478447e76ec0be88b6a86beb28b129e83c;hb=8af2956c86ba7556b0f7de3ad999a6b29ffbab9a;hpb=0ee400bd2f2a5f6a62808c1c95f2d63c96b5733e

diff --git a/urcu/static/wfstack.h b/urcu/static/wfstack.h
index 24f6cb4..1a0e4d7 100644
--- 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)