From 703622e03d7925faea41f0e879102de03e0d5f6c Mon Sep 17 00:00:00 2001 From: Diogo Cordeiro Date: Fri, 8 Jun 2018 13:36:23 +0100 Subject: [PATCH] Fix cfulist_destroy_with_free_fn() doc. It was declared again as cfulist_destroy() and didn't mention the effects related to cfulist_set_free_function(). --- doc/libcfu.texi | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/libcfu.texi b/doc/libcfu.texi index 89f7854..ba0f0b4 100644 --- a/doc/libcfu.texi +++ b/doc/libcfu.texi @@ -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