summaryrefslogtreecommitdiff
path: root/lib/gl_list.h
diff options
context:
space:
mode:
authorBruno Haible <bruno@clisp.org>2018-12-08 15:25:51 +0100
committerBruno Haible <bruno@clisp.org>2018-12-08 20:42:44 +0100
commitb457ace1eed823e5822884872034b42aa8a77b7f (patch)
tree686464c68ef8b735adb200ff7564cb5840aa884b /lib/gl_list.h
parent566f133cb4f1ebd329760eb92792b34f8d58b132 (diff)
downloadgnulib-b457ace1eed823e5822884872034b42aa8a77b7f.tar.gz
Fix comments.
* lib/gl_list.h (gl_list_free): Clarify what it does. * lib/gl_oset.h (gl_oset_free): Likewise. * lib/gl_set.h (gl_set_free): Likewise. * lib/gl_anytree_oset.h (gl_tree_search_atleast): Fix typo in comment. * lib/gl_array_oset.c (gl_array_search_atleast): Likewise. * lib/gl_anyavltree_list1.h (MAXHEIGHT): Likewise. * lib/gl_avltree_oset.c (MAXHEIGHT): Likewise.
Diffstat (limited to 'lib/gl_list.h')
-rw-r--r--lib/gl_list.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/gl_list.h b/lib/gl_list.h
index f050fe6d73..66d1ad904a 100644
--- a/lib/gl_list.h
+++ b/lib/gl_list.h
@@ -333,7 +333,9 @@ extern bool gl_list_remove_at (gl_list_t list, size_t position);
extern bool gl_list_remove (gl_list_t list, const void *elt);
/* Free an entire list.
- (But this call does not free the elements of the list.) */
+ (But this call does not free the elements of the list. It only invokes
+ the DISPOSE_FN on each of the elements of the list, and only if the list
+ is not a sublist.) */
extern void gl_list_free (gl_list_t list);
#endif /* End of inline and gl_xlist.h-defined functions. */