add first documentation draft and framework

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

diff --git a/include/ecoli_htable.h b/include/ecoli_htable.h
index 0bed676892ec0f97d7326dd76bff69cbf639dda1..3e9eab9dd31aa45d87d249ffb6414665bb80f171 100644 (file)
--- a/include/ecoli_htable.h
+++ b/include/ecoli_htable.h
@@ -3,7 +3,10 @@
  */
 
 /**
  */
 
 /**

- * Simple hash table API
+ * @defgroup htable Hash table
+ * @{
+ *
+ * @brief Simple hash table API (any key)

  *
  * This file provides functions to store objects in hash tables,
  * using arbitrary data as keys.
  *
  * This file provides functions to store objects in hash tables,
  * using arbitrary data as keys.


@@ -206,3 +209,5 @@ void *
 ec_htable_iter_get_val(const struct ec_htable_elt_ref *iter);
 
 #endif
 ec_htable_iter_get_val(const struct ec_htable_elt_ref *iter);
 
 #endif

+
+/** @} */