From: Vladimír Čunát <vladimir.cunat@nic.cz>
Date: Tue, 10 Apr 2018 17:15:58 +0000 (+0200)
Subject: lib/generic/trie: documentation nitpicks
X-Git-Tag: v2.3.0~12^2~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3aacb950bcd4b9e3a48940f59c75d9633a6ccad4;p=thirdparty%2Fknot-resolver.git

lib/generic/trie: documentation nitpicks
---

diff --git a/lib/generic/trie.h b/lib/generic/trie.h
index e4e1a2108..14f3d54ca 100644
--- a/lib/generic/trie.h
+++ b/lib/generic/trie.h
@@ -76,7 +76,8 @@ int trie_get_leq(trie_t *tbl, const char *key, uint32_t len, trie_val_t **val);
 /*!
  * \brief Apply a function to every trie_val_t, in order.
  *
- * \return KNOT_EOK if success or KNOT_E* if error.
+ * \param d Parameter passed as the second argument to f().
+ * \return First nonzero from f() or zero (i.e. KNOT_EOK).
  */
 int trie_apply(trie_t *tbl, int (*f)(trie_val_t *, void *), void *d);
 
@@ -107,7 +108,7 @@ void trie_it_free(trie_it_t *it);
 /*!
  * \brief Return pointer to the key of the current element.
  *
- * \note The len is uint32_t internally but size_t is better for our usage
+ * \note The optional len is uint32_t internally but size_t is better for our usage,
  *       as it is without an additional type conversion.
  */
 const char* trie_it_key(trie_it_t *it, size_t *len);