More doxygen comments
authorMichael Beck <beck@ipd.info.uni-karlsruhe.de>
Mon, 27 Sep 2004 14:51:34 +0000 (14:51 +0000)
committerMichael Beck <beck@ipd.info.uni-karlsruhe.de>
Mon, 27 Sep 2004 14:51:34 +0000 (14:51 +0000)
[r3968]

ir/adt/pset.h
ir/adt/set.h

index a922b3a..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!
  */
index a97ca62..cba43c0 100644 (file)
@@ -59,8 +59,9 @@ typedef int (*set_cmp_fun) (const void *elt, const void *key, size_t size);
 /**
  * Creates a new set.
  *
- * @param func    the compare function of this set
- * @param slots   number of initial slots
+ * @param func    The compare function of this set.
+ * @param slots   Initial number of collision chains.  I.e., #slots
+ *                different keys can be hashed without collisions.
  *
  * @returns
  *    created set