From 93a92aa8b9e44fdaa6c3493639709e7fb1fa3c4c Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Wed, 28 Sep 2016 13:54:00 +0200 Subject: [PATCH] src/daemon/utils_cache.h: Improve documentation for uc_iterator_get_next(). --- src/daemon/utils_cache.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/daemon/utils_cache.h b/src/daemon/utils_cache.h index 93c25194..e020429b 100644 --- a/src/daemon/utils_cache.h +++ b/src/daemon/utils_cache.h @@ -85,9 +85,9 @@ uc_iter_t *uc_get_iterator (void); * * PARAMETERS * `iter' The iterator object to advance. - * `ret_name' Pointer to a string where to store the name. The returned - * value is a copy of the value and has to be freed by the - * caller. + * `ret_name' Optional pointer to a string where to store the name. If not + * NULL, the returned value is a copy of the value and has to be + * freed by the caller. * * RETURN VALUE * Zero upon success or non-zero if the iterator ie NULL or no further -- 2.30.2