From: Olivier Matz <zer0@droids-corp.org>
Date: Sat, 10 Mar 2018 21:23:10 +0000 (+0100)
Subject: fix api comment in keyval
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=9ea36377cc6557fd9d40d02f45fd02a0c7dec877;p=protos%2Flibecoli.git

fix api comment in keyval
---

diff --git a/lib/ecoli_keyval.h b/lib/ecoli_keyval.h
index 5622b23..7d8b399 100644
--- a/lib/ecoli_keyval.h
+++ b/lib/ecoli_keyval.h
@@ -124,7 +124,18 @@ void ec_keyval_free(struct ec_keyval *keyval);
  */
 size_t ec_keyval_len(const struct ec_keyval *keyval);
 
-/* XXX help */
+/**
+ * Duplicate a hash table
+ *
+ * A reference counter is shared between the clones of
+ * hash tables so that the objects are freed only when
+ * the last reference is destroyed.
+ *
+ * @param keyval
+ *   The hash table.
+ * @return
+ *   The duplicated hash table, or NULL on error (errno is set).
+ */
 struct ec_keyval *ec_keyval_dup(const struct ec_keyval *keyval);
 
 /**