X-Git-Url: http://git.droids-corp.org/?p=protos%2Flibecoli.git;a=blobdiff_plain;f=include%2Fecoli_dict.h;h=b4bf7802dd0a3bc7820a5c78b6bff1c33e42e971;hp=5519c4c047a18fcca1ea3c28c110fefc844b27f0;hb=HEAD;hpb=41bf1ba66e15c00f38375d05e49b31aa70f92349 diff --git a/include/ecoli_dict.h b/include/ecoli_dict.h index 5519c4c..b4bf780 100644 --- a/include/ecoli_dict.h +++ b/include/ecoli_dict.h @@ -3,7 +3,10 @@ */ /** - * Simple hash table API + * @defgroup dict Dictionary + * @{ + * + * @brief Simple hash table API (string keys) * * This file provides functions to store objects in hash tables, using strings * as keys. @@ -160,7 +163,7 @@ struct ec_dict_elt_ref * ec_dict_iter_next(struct ec_dict_elt_ref *iter); /** - * Get the key of the current element. + * Get a pointer to the key of the current element. * * @param iter * The hash table iterator. @@ -183,5 +186,6 @@ ec_dict_iter_get_key(const struct ec_dict_elt_ref *iter); void * ec_dict_iter_get_val(const struct ec_dict_elt_ref *iter); - #endif + +/** @} */