[libgee] Fix the documentation of all implementations' constructor
- From: Didier Villevalois <dvillevalois src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [libgee] Fix the documentation of all implementations' constructor
- Date: Mon, 28 Sep 2009 17:47:47 +0000 (UTC)
commit 23721f320c6cd3a13e54731ddcfe28442cfa2b63
Author: Didier 'Ptitjes <ptitjes free fr>
Date: Mon Sep 28 19:44:32 2009 +0200
Fix the documentation of all implementations' constructor
Fixes bug 592817.
gee/arraylist.vala | 5 ++++-
gee/hashmap.vala | 9 ++++++---
gee/hashmultimap.vala | 14 +++++++++++++-
gee/hashmultiset.vala | 6 ++++++
gee/hashset.vala | 7 +++++--
gee/linkedlist.vala | 5 ++++-
gee/priorityqueue.vala | 8 ++++++++
gee/treemap.vala | 7 +++++--
gee/treemultimap.vala | 9 +++++++++
gee/treemultiset.vala | 5 +++++
gee/treeset.vala | 5 ++++-
11 files changed, 69 insertions(+), 11 deletions(-)
---
diff --git a/gee/arraylist.vala b/gee/arraylist.vala
index 474bdcb..3654fb1 100644
--- a/gee/arraylist.vala
+++ b/gee/arraylist.vala
@@ -59,7 +59,10 @@ public class Gee.ArrayList<G> : AbstractList<G> {
/**
* Constructs a new, empty array list.
*
- * @param equal_func an optional elements equality testing function.
+ * If not provided, the function parameter is requested to the
+ * { link Functions} function factory methods.
+ *
+ * @param equal_func an optional element equality testing function
*/
public ArrayList (EqualFunc? equal_func = null) {
if (equal_func == null) {
diff --git a/gee/hashmap.vala b/gee/hashmap.vala
index 6a6c7b2..cbe6d58 100644
--- a/gee/hashmap.vala
+++ b/gee/hashmap.vala
@@ -118,9 +118,12 @@ public class Gee.HashMap<K,V> : Gee.AbstractMap<K,V> {
/**
* Constructs a new, empty hash map.
*
- * @param key_hash_func a key hash function.
- * @param key_equal_func a key equality testing function.
- * @param value_equal_func a value equallity testing function.
+ * If not provided, the functions parameters are requested to the
+ * { link Functions} function factory methods.
+ *
+ * @param key_hash_func an optional key hash function
+ * @param key_equal_func an optional key equality testing function
+ * @param value_equal_func an optional value equality testing function
*/
public HashMap (HashFunc? key_hash_func = null, EqualFunc? key_equal_func = null, EqualFunc? value_equal_func = null) {
if (key_hash_func == null) {
diff --git a/gee/hashmultimap.vala b/gee/hashmultimap.vala
index 0961d19..3a10220 100644
--- a/gee/hashmultimap.vala
+++ b/gee/hashmultimap.vala
@@ -36,7 +36,19 @@ public class Gee.HashMultiMap<K,V> : AbstractMultiMap<K,V> {
public EqualFunc value_equal_func { private set; get; }
- public HashMultiMap (HashFunc? key_hash_func = null, EqualFunc? key_equal_func = null, HashFunc? value_hash_func = null, EqualFunc? value_equal_func = null) {
+ /**
+ * Constructs a new, empty hash multimap.
+ *
+ * If not provided, the functions parameters are requested to the
+ * { link Functions} function factory methods.
+ *
+ * @param key_hash_func an optional key hash function
+ * @param key_equal_func an optional key equality testing function
+ * @param value_hash_func an optional value hash function
+ * @param value_equal_func an optional value equality testing function
+ */
+ public HashMultiMap (HashFunc? key_hash_func = null, EqualFunc? key_equal_func = null,
+ HashFunc? value_hash_func = null, EqualFunc? value_equal_func = null) {
base (new HashMap<K, Set<V>> (key_hash_func, key_equal_func, direct_equal));
if (value_hash_func == null) {
value_hash_func = Functions.get_hash_func_for (typeof (V));
diff --git a/gee/hashmultiset.vala b/gee/hashmultiset.vala
index bcfb347..ed6135b 100644
--- a/gee/hashmultiset.vala
+++ b/gee/hashmultiset.vala
@@ -34,6 +34,12 @@ public class Gee.HashMultiSet<G> : AbstractMultiSet<G> {
/**
* Constructs a new, empty hash multi set.
+ *
+ * If not provided, the functions parameters are requested to the
+ * { link Functions} function factory methods.
+ *
+ * @param hash_func an optional element hash function
+ * @param equal_func an optional element equality testing function
*/
public HashMultiSet (HashFunc? hash_func = null, EqualFunc? equal_func = null) {
base (new HashMap<G, int> (hash_func, equal_func, int_equal));
diff --git a/gee/hashset.vala b/gee/hashset.vala
index d34a94a..717e5e2 100644
--- a/gee/hashset.vala
+++ b/gee/hashset.vala
@@ -64,8 +64,11 @@ public class Gee.HashSet<G> : AbstractSet<G> {
/**
* Constructs a new, empty hash set.
*
- * @param hash_func an optional hash function.
- * @param equal_func an optional equality testing function.
+ * If not provided, the functions parameters are requested to the
+ * { link Functions} function factory methods.
+ *
+ * @param hash_func an optional hash function
+ * @param equal_func an optional equality testing function
*/
public HashSet (HashFunc? hash_func = null, EqualFunc? equal_func = null) {
if (hash_func == null) {
diff --git a/gee/linkedlist.vala b/gee/linkedlist.vala
index f01ea47..68b7840 100644
--- a/gee/linkedlist.vala
+++ b/gee/linkedlist.vala
@@ -46,7 +46,10 @@ public class Gee.LinkedList<G> : AbstractList<G>, Queue<G>, Deque<G> {
/**
* Constructs a new, empty linked list.
*
- * @param equal_func an optional equality testing function.
+ * If not provided, the function parameter is requested to the
+ * { link Functions} function factory methods.
+ *
+ * @param equal_func an optional element equality testing function
*/
public LinkedList (EqualFunc? equal_func = null) {
if (equal_func == null) {
diff --git a/gee/priorityqueue.vala b/gee/priorityqueue.vala
index 2f07bdf..74337a0 100644
--- a/gee/priorityqueue.vala
+++ b/gee/priorityqueue.vala
@@ -60,6 +60,14 @@ public class Gee.PriorityQueue<G> : Gee.AbstractQueue<G> {
private Type1Node<G>? _ll_head = null;
private Type1Node<G>? _ll_tail = null;
+ /**
+ * Constructs a new, empty priority queue.
+ *
+ * If not provided, the function parameter is requested to the
+ * { link Functions} function factory methods.
+ *
+ * @param compare_func an optional element comparator function
+ */
public PriorityQueue (CompareFunc? compare_func = null) {
if (compare_func == null) {
compare_func = Functions.get_compare_func_for (typeof (G));
diff --git a/gee/treemap.vala b/gee/treemap.vala
index 97b4ef1..77c599f 100644
--- a/gee/treemap.vala
+++ b/gee/treemap.vala
@@ -104,8 +104,11 @@ public class Gee.TreeMap<K,V> : Gee.AbstractMap<K,V> {
* Constructs a new, empty tree map sorted according to the specified
* comparator function.
*
- * @param key_compare_func an optional key comparator function.
- * @param value_equal_func an optional values equality testing function.
+ * If not provided, the functions parameters are requested to the
+ * { link Functions} function factory methods.
+ *
+ * @param key_compare_func an optional key comparator function
+ * @param value_equal_func an optional values equality testing function
*/
public TreeMap (CompareFunc? key_compare_func = null, EqualFunc? value_equal_func = null) {
if (key_compare_func == null) {
diff --git a/gee/treemultimap.vala b/gee/treemultimap.vala
index f318a78..c26729e 100644
--- a/gee/treemultimap.vala
+++ b/gee/treemultimap.vala
@@ -31,6 +31,15 @@ public class Gee.TreeMultiMap<K,V> : AbstractMultiMap<K,V> {
public CompareFunc value_compare_func { private set; get; }
+ /**
+ * Constructs a new, empty tree multimap.
+ *
+ * If not provided, the functions parameters are requested to the
+ * { link Functions} function factory methods.
+ *
+ * @param key_compare_func an optional key comparator function
+ * @param value_compare_func an optional value comparator function
+ */
public TreeMultiMap (CompareFunc? key_compare_func = null, CompareFunc? value_compare_func = null) {
base (new TreeMap<K, Set<V>> (key_compare_func, direct_equal));
if (value_compare_func == null) {
diff --git a/gee/treemultiset.vala b/gee/treemultiset.vala
index f940a25..2b2b37f 100644
--- a/gee/treemultiset.vala
+++ b/gee/treemultiset.vala
@@ -31,6 +31,11 @@ public class Gee.TreeMultiSet<G> : AbstractMultiSet<G> {
/**
* Constructs a new, empty tree multi set.
+ *
+ * If not provided, the function parameter is requested to the
+ * { link Functions} function factory methods.
+ *
+ * @param compare_func an optional element comparator function
*/
public TreeMultiSet (CompareFunc? compare_func = null) {
base (new TreeMap<G, int> (compare_func, int_equal));
diff --git a/gee/treeset.vala b/gee/treeset.vala
index 2cb3ee7..53a7848 100644
--- a/gee/treeset.vala
+++ b/gee/treeset.vala
@@ -51,7 +51,10 @@ public class Gee.TreeSet<G> : AbstractSet<G>, SortedSet<G> {
* Constructs a new, empty tree set sorted according to the specified
* comparator function.
*
- * @param compare_func an optional elements comparator function.
+ * If not provided, the function parameter is requested to the
+ * { link Functions} function factory methods.
+ *
+ * @param compare_func an optional element comparator function
*/
public TreeSet (CompareFunc? compare_func = null) {
if (compare_func == null) {
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]