add missing doxygen docu

[libfirm] / include / libfirm / adt / pmap.h

diff --git a/include/libfirm/adt/pmap.h b/include/libfirm/adt/pmap.h
index dc53aad..3bb507e 100644 (file)
--- a/include/libfirm/adt/pmap.h
+++ b/include/libfirm/adt/pmap.h
@@ -19,7 +19,7 @@
 
 /**
  * @file
- * @brief       Simplified hashnap for pointer->pointer relations
+ * @brief       Simplified hashmap for pointer->pointer relations
  * @author      Hubert Schmid
  * @date        09.06.2002
  */
@@ -30,6 +30,13 @@
 
 #include "../begin.h"
 
+/**
+ * @ingroup adt
+ * @defgroup pmap Pointer Map
+ * Pointer->Pointer hashmap
+ * @{
+ */
+
 /**  A map which maps addresses to addresses. */
 typedef struct pmap pmap;
 
@@ -61,11 +68,19 @@ FIRM_API void pmap_insert(pmap *map, const void * key, void * value);
 FIRM_API int pmap_contains(pmap *map, const void * key);
 
 /** Returns the key, value pair of "key". */
-FIRM_API pmap_entry * pmap_find(pmap *map, const void * key);
+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 */
 FIRM_API size_t pmap_count(pmap *map);
 
 /**
@@ -78,6 +93,9 @@ FIRM_API pmap_entry *pmap_first(pmap *map);
  */
 FIRM_API pmap_entry *pmap_next(pmap *);
 
+/**
+ * Iterate over all elements in the map setting curr to the current element.
+ */
 #define foreach_pmap(pmap, curr) \
        for (curr = pmap_first(pmap); curr; curr = pmap_next(pmap))
 
@@ -86,6 +104,10 @@ FIRM_API pmap_entry *pmap_next(pmap *);
  */
 FIRM_API void pmap_break(pmap *map);
 
+/**
+ * @}
+ */
+
 #include "../end.h"
 
 #endif