Commit 8c8f4b88 authored by Maciej (Matthew) Piechotka's avatar Maciej (Matthew) Piechotka
Browse files

Fix the valadoc documentation

parent c9edcbf9
......@@ -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) {
......
......@@ -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 (() => {
......
......@@ -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);
}
......
......@@ -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) {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment