api documentation for ec_parse

[protos/libecoli.git] / include / ecoli_dict.h

diff --git a/include/ecoli_dict.h b/include/ecoli_dict.h
index e44246601f1a61f018f1bd0dbd4025b19eed6601..b4bf7802dd0a3bc7820a5c78b6bff1c33e42e971 100644 (file)
--- 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.
@@ -184,3 +187,5 @@ void *
 ec_dict_iter_get_val(const struct ec_dict_elt_ref *iter);
 
 #endif
+
+/** @} */