fix documentation of return value of cx_linked_list_find()

Sat, 13 Sep 2025 20:55:56 +0200

author
Mike Becker <universe@uap-core.de>
date
Sat, 13 Sep 2025 20:55:56 +0200
changeset 1374
4dceda670b05
parent 1373
a6aaa77b6809
child 1375
e0ba5e20e77a

fix documentation of return value of cx_linked_list_find()

src/cx/linked_list.h file | annotate | diff | comparison | revisions
--- a/src/cx/linked_list.h	Fri Sep 12 16:56:04 2025 +0200
+++ b/src/cx/linked_list.h	Sat Sep 13 20:55:56 2025 +0200
@@ -154,7 +154,7 @@
  * @param elem a pointer to the element to find
  * @param found_index an optional pointer where the index of the found node
  * (given that @p start has index 0) is stored
- * @return the index of the element, if found - unspecified if not found
+ * @return a pointer to the found node or @c NULL if no matching node was found
  */
 cx_attr_nonnull_arg(1, 4, 5)
 cx_attr_export

mercurial