Add a wrapper macro for pmap_get(), which has the return type as additional parameter.

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

diff --git a/include/libfirm/adt/cpset.h b/include/libfirm/adt/cpset.h
index 856e32e..b13fea0 100644 (file)
--- a/include/libfirm/adt/cpset.h
+++ b/include/libfirm/adt/cpset.h
@@ -28,6 +28,13 @@
 
 #include "../begin.h"
 
+/**
+ * @ingroup adt
+ * @defgroup Pointer Set (custom Compare)
+ * A pointer set with user-definable compare function
+ * @{
+ */
+
 /**
  * The type of a cpset compare function.
  *
@@ -43,6 +50,8 @@ typedef int (*cpset_cmp_function) (const void *p1, const void *p2);
  */
 typedef unsigned (*cpset_hash_function) (const void *obj);
 
+/** @cond PRIVATE */
+
 #define HashSet          cpset_t
 #define HashSetIterator  cpset_iterator_t
 #define HashSetEntry     cpset_hashset_entry_t
@@ -55,7 +64,12 @@ typedef unsigned (*cpset_hash_function) (const void *obj);
 #undef HashSetIterator
 #undef HashSet
 
+/** @endcond */
+
+/** a pointer set with custom compare function */
 typedef struct cpset_t          cpset_t;
+/** iterator over a pointer set with custom compare function
+ * @see #cpset_t */
 typedef struct cpset_iterator_t cpset_iterator_t;
 
 /**
@@ -151,6 +165,8 @@ FIRM_API void *cpset_iterator_next(cpset_iterator_t *iterator);
  */
 FIRM_API void cpset_remove_iterator(cpset_t *cpset, const cpset_iterator_t *iterator);
 
+/** @} */
+
 #include "../end.h"
 
 #endif