Commit 485c6939 authored by Matthias Braun's avatar Matthias Braun
Browse files

add missing doxygen docu

parent f2ad275b
......@@ -73,6 +73,11 @@ FIRM_API pmap_entry *pmap_find(pmap *map, const void * key);
/** Returns the value of "key". */
FIRM_API void * pmap_get(pmap *map, const void * key);
/**
* Returns the value of "key".
* This is a wrapper for pmap_get(pmap *map); It allows to express the
* intended type of the set elements (instead of weakly typed void*).
*/
#define pmap_get(type, map, key) ((type*)pmap_get(map, key))
/** Return number of elements in the map */
......
......@@ -189,6 +189,16 @@ FIRM_API void *pset_remove(pset *pset, const void *key, unsigned hash);
*/
FIRM_API void *pset_first(pset *pset);
/**
* Returns the first element of a pset.
* This is a wrapper for pset_first(pmap *map); It allows to express the
* intended type of the set elements (instead of weakly typed void*).
*
* @param type destination type of the pointers in the set
* @param pset the pset to iterate
*
* @return a pointer to the element or NULL if the set is empty
*/
#define pset_first(type, pset) ((type*)pset_first((pset)))
/**
......@@ -201,6 +211,17 @@ FIRM_API void *pset_first(pset *pset);
*/
FIRM_API void *pset_next(pset *pset);
/**
* Returns the next element of a pset.
* This is a wrapper for pset_next(pmap *map); It allows to express the
* intended type of the set elements (instead of weakly typed void*).
*
* @param type destination type of the pointers in the set
* @param pset the pset to iterate
*
* @return a pointer to the next element or NULL if the
* iteration is finished
*/
#define pset_next(type, pset) ((type*)pset_next((pset)))
/**
......
......@@ -171,6 +171,16 @@ FIRM_API set_entry *set_hinsert0(set *set, const void *key, size_t size, unsigne
*/
FIRM_API void *set_first(set *set);
/**
* Returns the first element of a set.
* This is a wrapper for set_first(set *set); It allows to express the
* intended type of the set elements (instead of weakly typed void*).
*
* @param set the set to iterate
* @param type type of the set elements
*
* @return a pointer to the element or NULL if the set is empty
*/
#define set_first(type, set) ((type*)set_first((set)))
/**
......@@ -183,6 +193,17 @@ FIRM_API void *set_first(set *set);
*/
FIRM_API void *set_next(set *set);
/**
* Returns the next element of a set.
* This is a wrapper for set_next(set *set); It allows to express the
* intended type of the set elements (instead of weakly typed void*).
*
* @param set the set to iterate
* @param type type of the set elements
*
* @return a pointer to the next element or NULL if the
* iteration is finished
*/
#define set_next(type, set) ((type*)set_next((set)))
/**
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment