Merge remote-tracking branch 'github/pr/2040'

[collectd.git] / src / daemon / utils_cache.h

diff --git a/src/daemon/utils_cache.h b/src/daemon/utils_cache.h
index 93c2519469f6f9436468719db5da0a49fc0fbdf1..e020429bee06c999b4fb0fd9faa3dc0ace21592c 100644 (file)
--- 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