From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Mon, 19 Sep 2011 20:22:49 +0000 (-0400)
Subject: rculfhash: document flags
X-Git-Tag: v0.7.0~43^2~142
X-Git-Url: https://git.lttng.org/?p=urcu.git;a=commitdiff_plain;h=f22dd01d7941170a1b1b0275344a6e6cd83dbcc6

rculfhash: document flags

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
---

diff --git a/urcu/rculfhash.h b/urcu/rculfhash.h
index 95fff09..bc9f232 100644
--- a/urcu/rculfhash.h
+++ b/urcu/rculfhash.h
@@ -99,8 +99,14 @@ struct cds_lfht *_cds_lfht_new(cds_lfht_hash_fct hash_fct,
 
 /*
  * cds_lfht_new - allocate a hash table.
+ * @hash_fct: the hashing function.
+ * @compare_fct: the key comparison function.
+ * @hash_seed: the seed for hash function.
+ * @init_size: number of nodes to allocate initially. Must be power of two.
+ * @flags: hash table creation flags (can be combined with bitwise or: '|').
+ *           0: no flags.
+ *           CDS_LFHT_AUTO_RESIZE: automatically resize hash table.
  *
- * init_size must be power of two.
  * Return NULL on error.
  * Note: the RCU flavor must be already included before the hash table header.
  */