fixed some depencies between irdump.c and irdumptxt.c
[libfirm] / ir / adt / pset.h
index 620a44d..059005f 100644 (file)
@@ -45,8 +45,9 @@ typedef int (*pset_cmp_fun) (const void *elt, const void *key);
 /**
  * Creates a new pset.
  *
- * @param func    the compare function of this pset
- * @param slots   number of initial slots
+ * @param func    The compare function of this pset.
+ * @param slots   Initial number of collision chains.  I.e., #slots
+ *                different keys can be hashed without collisions.
  *
  * @returns
  *    created pset
@@ -56,6 +57,8 @@ pset *new_pset (pset_cmp_fun func, int slots);
 /**
  * Deletes a pset.
  *
+ * @param pset   the pset
+ *
  * @note
  *    This does NOT delete the elements of this pset, just it's pointers!
  */
@@ -72,7 +75,7 @@ int pset_count (pset *pset);
  * Searches an element pointer in a pset.
  *
  * @param pset  the pset to search in
- * @param key   the element to is searched
+ * @param key   the element to search
  * @param hash  the hash value of key
  *
  * @return
@@ -92,7 +95,7 @@ void *pset_find (pset *pset, const void *key, unsigned hash);
  * @note
  *    It is not possible to insert on element more than once. If a element
  *    that should be inserted is already in the set, this functions does
- *    nothing but returning its set_entry.
+ *    nothing but returning its already existing set_entry.
 
  */
 void *pset_insert (pset *pset, const void *key, unsigned hash);