api documentation for ec_parse

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

diff --git a/include/ecoli_htable.h b/include/ecoli_htable.h
index 6729d91..3e9eab9 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.
@@ -178,9 +181,21 @@ ec_htable_iter_next(struct ec_htable_elt_ref *iter);
  *   The current element key, or NULL if the iterator points to an
  *   invalid element.
  */
-const char *
+const void *
 ec_htable_iter_get_key(const struct ec_htable_elt_ref *iter);
 
+/**
+ * Get the key length of the current element.
+ *
+ * @param iter
+ *   The hash table iterator.
+ * @return
+ *   The current element key length, or 0 if the iterator points to an
+ *   invalid element.
+ */
+size_t
+ec_htable_iter_get_key_len(const struct ec_htable_elt_ref *iter);
+
 /**
  * Get the value of the current element.
  *
@@ -193,5 +208,6 @@ ec_htable_iter_get_key(const struct ec_htable_elt_ref *iter);
 void *
 ec_htable_iter_get_val(const struct ec_htable_elt_ref *iter);
 
-
 #endif
+
+/** @} */