From 9ea36377cc6557fd9d40d02f45fd02a0c7dec877 Mon Sep 17 00:00:00 2001 From: Olivier Matz Date: Sat, 10 Mar 2018 22:23:10 +0100 Subject: [PATCH] fix api comment in keyval --- lib/ecoli_keyval.h | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) 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); /** -- 2.39.5