added doxygen comments

[libfirm] / ir / adt / pset.h

diff --git a/ir/adt/pset.h b/ir/adt/pset.h
index 6d93bde..9a42d1b 100644 (file)
--- a/ir/adt/pset.h
+++ b/ir/adt/pset.h
@@ -16,6 +16,15 @@
 #include <stddef.h>
 
 #include "hashptr.h"
+#include "iterator.h"
+
+/**
+ * The default comparison function for pointers.
+ * @param x A pointer.
+ * @param y A pointer.
+ * @return 0 if @p x and @p y are equal. Some value != 0 otherwise.
+ */
+int pset_default_ptr_cmp(const void *x, const void *y);
 
 /*
  * Define some convenience macros using the predefined hash function.
@@ -24,6 +33,8 @@
 #define pset_hinsert_ptr(set,key) pset_hinsert(set, key, HASH_PTR(key))
 #define pset_remove_ptr(set,key) pset_remove(set, key, HASH_PTR(key))
 #define pset_find_ptr(set,key) pset_find(set, key, HASH_PTR(key))
+#define pset_new_ptr(slots) new_pset(pset_default_ptr_cmp, slots)
+#define pset_new_ptr_default() pset_new_ptr(64)
 
 /**
  * The abstract type of a pset (Set of pointers).
@@ -89,7 +100,7 @@ int pset_count (pset *pset);
  * @param hash  the hash value of key
  *
  * @return
- *    the pointer of the found element in the pset of NULL if it was not found
+ *    the pointer of the found element in the pset or NULL if it was not found
  */
 void *pset_find (pset *pset, const void *key, unsigned hash);