git.droids-corp.org
/
protos
/
libecoli.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
api documentation
[protos/libecoli.git]
/
include
/
ecoli_dict.h
diff --git
a/include/ecoli_dict.h
b/include/ecoli_dict.h
index
5519c4c
..
b4bf780
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.
@@
-160,7
+163,7
@@
struct ec_dict_elt_ref *
ec_dict_iter_next(struct ec_dict_elt_ref *iter);
/**
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.
*
* @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);
void *
ec_dict_iter_get_val(const struct ec_dict_elt_ref *iter);
-
#endif
#endif
+
+/** @} */