diogo/libcfu
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix cfulist_destroy_with_free_fn() doc.

Browse Source 
It was declared again as cfulist_destroy() and didn't mention the effects related to cfulist_set_free_function().
This commit is contained in:
Diogo Cordeiro 2018-06-08 13:36:23 +01:00
parent 4f4439828f
commit 703622e03d
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/libcfu.texi
View File

@ -581,10 +581,12 @@ position in the new list.
Free all resources used by the list.
@end deftypefun
@deftypefun {void} cfulist_destroy (cfulist_t * @var{list}, cfulist_free_fn_t @var{free_fn})
@deftypefun {void} cfulist_destroy_with_free_fn (cfulist_t * @var{list}, cfulist_free_fn_t @var{free_fn})
Free all resources used by the list. If free_fn is not NULL, call it
Free all resources used by the list. If free_fn is not NULL, is called
for each element of the list, passing the data to it as a void *.
If free_fn is not NULL, it overrides any function set previously
with cfulist_set_free_function().
@end deftypefun