From: Florian Forster <octo@collectd.org>
Date: Wed, 28 Sep 2016 11:54:00 +0000 (+0200)
Subject: src/daemon/utils_cache.h: Improve documentation for uc_iterator_get_next().
X-Git-Tag: collectd-5.7.0~64
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=93a92aa8b9e44fdaa6c3493639709e7fb1fa3c4c;p=collectd.git

src/daemon/utils_cache.h: Improve documentation for uc_iterator_get_next().
---

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