[libgee] Fix the valadoc documentation
- From: Maciej Marcin Piechotka <mpiechotka src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgee] Fix the valadoc documentation
- Date: Sun, 17 Feb 2013 12:07:41 +0000 (UTC)
commit 8c8f4b8848c3f3d7dbf1f70d91ae419cfa71c0f0
Author: Maciej Piechotka <uzytkownik2 gmail com>
Date: Sun Feb 17 12:06:23 2013 +0000
Fix the valadoc documentation
gee/arraylist.vala | 2 +-
gee/hazardpointer.vala | 4 ++--
gee/map.vala | 18 +++++-------------
gee/traversable.vala | 4 +++-
4 files changed, 11 insertions(+), 17 deletions(-)
---
diff --git a/gee/arraylist.vala b/gee/arraylist.vala
index 4cc99d1..b95ecf7 100644
--- a/gee/arraylist.vala
+++ b/gee/arraylist.vala
@@ -87,7 +87,7 @@ public class Gee.ArrayList<G> : AbstractBidirList<G> {
* If not provided, the function parameter is requested to the
* { link Functions} function factory methods.
*
- * @param itmes initial items to be put into array
+ * @param items initial items to be put into array
* @param equal_func an optional element equality testing function
*/
public ArrayList.wrap (owned G[] items, owned EqualDataFunc<G>? equal_func = null) {
diff --git a/gee/hazardpointer.vala b/gee/hazardpointer.vala
index 1436d26..3151632 100644
--- a/gee/hazardpointer.vala
+++ b/gee/hazardpointer.vala
@@ -451,13 +451,13 @@ public class Gee.HazardPointer<G> { // FIXME: Make it a struct
private static void start (ReleasePolicy self) { // FIXME: Make it non-static [bug 659778]
switch (self) {
case HELPER_THREAD:
- new Thread<bool> ("<<Gee.HazardPointer.Executor>>", () => {
+ Thread.create<bool> (() => {
Thread.self<bool> ().set_priority (ThreadPriority.LOW);
while (true) {
Thread.yield ();
attempt_free ();
}
- });
+ }, false);
break;
case MAIN_LOOP:
Idle.add (() => {
diff --git a/gee/map.vala b/gee/map.vala
index 33b99a3..e8e3138 100644
--- a/gee/map.vala
+++ b/gee/map.vala
@@ -71,7 +71,7 @@ public interface Gee.Map<K,V> : Object, Iterable<Map.Entry<K,V>> {
public abstract V value { get; set; }
/**
- * ``true'' if the setting value is permitted.
+ * ``true`` if the setting value is permitted.
*/
public abstract bool read_only { get; }
}
@@ -91,10 +91,8 @@ public interface Gee.Map<K,V> : Object, Iterable<Map.Entry<K,V>> {
* @param key the key to locate in the map
*
* @return ``true`` if key is found, ``false`` otherwise
- *
- * @deprecated Use { link has_key} method instead.
*/
- [Deprecated]
+ [Deprecated (replacement = "Map.has_key")]
public bool contains (K key) {
return has_key(key);
}
@@ -144,10 +142,8 @@ public interface Gee.Map<K,V> : Object, Iterable<Map.Entry<K,V>> {
* @param value the receiver variable for the removed value
*
* @return ``true`` if the map has been changed, ``false`` otherwise
- *
- * @deprecated Use { link unset} method instead.
*/
- [Deprecated]
+ [Deprecated (replacement = "Map.unset")]
public bool remove (K key, out V? value = null) {
return unset (key, out value);
}
@@ -195,10 +191,8 @@ public interface Gee.Map<K,V> : Object, Iterable<Map.Entry<K,V>> {
* and this map.
*
* @param map the map which common items are deleted from this map
- *
- * @deprecated Use { link unset_all} method instead.
*/
- [Deprecated]
+ [Deprecated (replacement = "Map.unset_all")]
public bool remove_all (Map<K,V> map) {
return unset_all (map);
}
@@ -221,10 +215,8 @@ public interface Gee.Map<K,V> : Object, Iterable<Map.Entry<K,V>> {
* Returns ``true`` it this map contains all items as the input map.
*
* @param map the map which items will be compared with this map
- *
- * @deprecated Use { link has_all} method instead.
*/
- [Deprecated]
+ [Deprecated (replacement = "Map.has_all")]
public bool contains_all (Map<K,V> map) {
return has_all (map);
}
diff --git a/gee/traversable.vala b/gee/traversable.vala
index 9c8a183..e9ead40 100644
--- a/gee/traversable.vala
+++ b/gee/traversable.vala
@@ -59,6 +59,8 @@ public interface Gee.Traversable<G> : Object {
* to last element in iteration or the first element that returned ''false''.
* If iterator points at some element it will be included in iteration.
*
+ * @param f function applied to every element of the collection
+ *
* @return ''false'' if the argument returned ''false'' at last invocation and
* ''true'' otherwise.
*/
@@ -286,7 +288,7 @@ public interface Gee.Traversable<G> : Object {
* iterator is { link Iterator.valid} and value it is pointing on
* fullfills the predicate.
*
- * @param f Folding function
+ * @param pred predicate to check should the value be retained
* @return Iterator containing values of subsequent values of seed
*/
public virtual Iterator<G> filter (owned Predicate<G> pred) {
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]