add first documentation draft and framework

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

diff --git a/include/ecoli_dict.h b/include/ecoli_dict.h
index 77558fb2aec4e3f63ba624467e4c616413e85317..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.
  *
  * This file provides functions to store objects in hash tables, using strings
  * as keys.


@@ -184,3 +187,5 @@ void *
 ec_dict_iter_get_val(const struct ec_dict_elt_ref *iter);
 
 #endif
 ec_dict_iter_get_val(const struct ec_dict_elt_ref *iter);
 
 #endif

+
+/** @} */