diff options
author | Reuben Thomas <rrt@sc3d.org> | 2020-10-19 12:58:49 +0100 |
---|---|---|
committer | Rico Tzschichholz <ricotz@ubuntu.com> | 2020-10-23 08:18:45 +0200 |
commit | 8b76b8cd0d1dafcf0a48048e6742a34d2c5e15c2 (patch) | |
tree | b22310c2dd01f99e71f3cf11787621d945c0e138 | |
parent | 56b10bc2c272f345536709f0abdaf857ba1b4080 (diff) | |
download | libgee-8b76b8cd0d1dafcf0a48048e6742a34d2c5e15c2.tar.gz |
Various English and typo fixes in the documentation
-rw-r--r-- | gee/collection.vala | 8 | ||||
-rw-r--r-- | gee/comparable.vala | 2 | ||||
-rw-r--r-- | gee/concurrentlist.vala | 2 | ||||
-rw-r--r-- | gee/concurrentset.vala | 2 | ||||
-rw-r--r-- | gee/deque.vala | 2 | ||||
-rw-r--r-- | gee/future.vala | 2 | ||||
-rw-r--r-- | gee/hashable.vala | 4 | ||||
-rw-r--r-- | gee/hashmap.vala | 2 | ||||
-rw-r--r-- | gee/hashset.vala | 2 | ||||
-rw-r--r-- | gee/hazardpointer.vala | 14 | ||||
-rw-r--r-- | gee/iterator.vala | 8 | ||||
-rw-r--r-- | gee/linkedlist.vala | 2 | ||||
-rw-r--r-- | gee/list.vala | 8 | ||||
-rw-r--r-- | gee/map.vala | 8 | ||||
-rw-r--r-- | gee/mapiterator.vala | 8 | ||||
-rw-r--r-- | gee/multimap.vala | 2 | ||||
-rw-r--r-- | gee/multiset.vala | 6 | ||||
-rw-r--r-- | gee/queue.vala | 4 | ||||
-rw-r--r-- | gee/sortedset.vala | 2 | ||||
-rw-r--r-- | gee/task.vala | 4 | ||||
-rw-r--r-- | gee/traversable.vala | 18 | ||||
-rw-r--r-- | tests/testcollection.vala | 2 | ||||
-rw-r--r-- | tests/testlist.vala | 2 |
23 files changed, 58 insertions, 56 deletions
diff --git a/gee/collection.vala b/gee/collection.vala index 35c3286..3aaacfe 100644 --- a/gee/collection.vala +++ b/gee/collection.vala @@ -38,7 +38,7 @@ public interface Gee.Collection<G> : Iterable<G> { public virtual bool is_empty { get { return size == 0; } } /** - * Specifies whether this collection can change - i.e. wheather {@link add}, + * Specifies whether this collection can change - i.e. whether {@link add}, * {@link remove} etc. are legal operations. */ [CCode (ordering = 11)] @@ -66,7 +66,7 @@ public interface Gee.Collection<G> : Iterable<G> { public abstract bool add (G item); /** - * Removes the first occurence of an item from this collection. Must not + * Removes the first occurrence of an item from this collection. Must not * be called on read-only collections. * * @param item the item to remove from the collection @@ -112,7 +112,7 @@ public interface Gee.Collection<G> : Iterable<G> { /** * Removes the subset of items in this collection corresponding to the - * elments in the input collection. If there is several occurrences of + * elements in the input collection. If there is several occurrences of * the same value in this collection they are decremented of the number * of occurrences in the input collection. * @@ -283,7 +283,7 @@ public interface Gee.Collection<G> : Iterable<G> { /** * Removes the subset of items in this collection corresponding to the - * elments in the input array. If there is several occurrences of + * elements in the input array. If there is several occurrences of * the same value in this collection they are decremented of the number * of occurrences in the input array. * diff --git a/gee/comparable.vala b/gee/comparable.vala index 6ee158e..82a4c6c 100644 --- a/gee/comparable.vala +++ b/gee/comparable.vala @@ -40,7 +40,7 @@ */ public interface Gee.Comparable<G> : Object { /** - * Compares this object with the specifed object. + * Compares this object with the specified object. * * @return a negative integer, zero, or a positive integer as this object * is less than, equal to, or greater than the specified object diff --git a/gee/concurrentlist.vala b/gee/concurrentlist.vala index 8d6d5f9..6e511f1 100644 --- a/gee/concurrentlist.vala +++ b/gee/concurrentlist.vala @@ -471,7 +471,7 @@ public class Gee.ConcurrentList<G> : AbstractList<G> { prev = (owned)curr; curr = (owned)next; #if DEBUG - stderr.printf (" Procceed to %p (previous %p)\n", curr, prev); + stderr.printf (" Proceed to %p (previous %p)\n", curr, prev); #endif } return success; diff --git a/gee/concurrentset.vala b/gee/concurrentset.vala index c5bfce9..c5c7751 100644 --- a/gee/concurrentset.vala +++ b/gee/concurrentset.vala @@ -25,7 +25,7 @@ * [[http://www.cse.yorku.ca/~ruppert/Mikhail.pdf|Mikhail Fomitchev Master Thesis]]. * * Many threads are allowed to operate on the same structure as well as modification - * of structure during iteration is allowed. However the change may not be immidiatly + * of structure during iteration is allowed. However the change may not be immediately * visible to other threads. */ public class Gee.ConcurrentSet<G> : AbstractSortedSet<G> { diff --git a/gee/deque.vala b/gee/deque.vala index b28c15a..f5356ca 100644 --- a/gee/deque.vala +++ b/gee/deque.vala @@ -30,7 +30,7 @@ * the {@link Queue} methods with respect to capacity bounds. * * The Deque interface inherits from the {@link Queue} interface. Thus, to use - * a deque as a queue, you can equivalently use the folowing method set: + * a deque as a queue, you can equivalently use the following method set: * * ||<)(> ''Queue method'' ||<)(> ''Deque method'' || * || {@link Queue.offer} || {@link offer_tail} || diff --git a/gee/future.vala b/gee/future.vala index 654041b..7eb9001 100644 --- a/gee/future.vala +++ b/gee/future.vala @@ -61,7 +61,7 @@ public interface Gee.Future<G> : Object { /** * Checks if value is ready. If it is calls to {@link wait} and - * {@link wait_until} will not block and value is returned immidiatly. + * {@link wait_until} will not block and value is returned immediately. */ [CCode (ordering = 8)] public abstract bool ready {get;} diff --git a/gee/hashable.vala b/gee/hashable.vala index dd5f3c0..e3f33fe 100644 --- a/gee/hashable.vala +++ b/gee/hashable.vala @@ -21,7 +21,7 @@ */ /** - * This interface defines a hash function amongs instances of each class + * This interface defines a hash function among instances of each class * implementing it. * * @see Comparable @@ -38,7 +38,7 @@ public interface Gee.Hashable<G> : Object { public abstract uint hash (); /** - * Compares this object with the specifed object. This defines the + * Compares this object with the specified object. This defines the * equivalence relation between them. * * In other words: diff --git a/gee/hashmap.vala b/gee/hashmap.vala index 8d6b158..b07d35e 100644 --- a/gee/hashmap.vala +++ b/gee/hashmap.vala @@ -28,7 +28,7 @@ using GLib; /** * Hash table implementation of the {@link Map} interface. * - * This implementation is better fit for highly heterogenous key values. + * This implementation is better fit for highly heterogeneous key values. * In case of high key hashes redundancy or higher amount of data prefer using * tree implementation like {@link TreeMap}. * diff --git a/gee/hashset.vala b/gee/hashset.vala index 230f564..ef6d5a2 100644 --- a/gee/hashset.vala +++ b/gee/hashset.vala @@ -67,7 +67,7 @@ namespace Gee { /** * Hash table implementation of the {@link Set} interface. * - * This implementation is better fit for highly heterogenous values. + * This implementation is better fit for highly heterogeneous values. * In case of high value hashes redundancy or higher amount of data prefer using * tree implementation like {@link TreeSet}. * diff --git a/gee/hazardpointer.vala b/gee/hazardpointer.vala index f95fd74..3df5827 100644 --- a/gee/hazardpointer.vala +++ b/gee/hazardpointer.vala @@ -118,7 +118,7 @@ public class Gee.HazardPointer<G> { // FIXME: Make it a struct } /** - * Exchange objects safly. + * Exchange objects safely. * * @param aptr Atomic pointer. * @param new_ptr New value @@ -173,7 +173,7 @@ public class Gee.HazardPointer<G> { // FIXME: Make it a struct } /** - * Exchange objects safly. + * Exchange objects safely. * * @param aptr Atomic pointer. * @param new_ptr New value @@ -249,7 +249,7 @@ public class Gee.HazardPointer<G> { // FIXME: Make it a struct */ public static void set_default_policy (Policy policy) requires (policy.is_concrete ()) { if (policy.is_blocking ()) - warning ("Setting blocking defautl Gee.HazardPointer.Policy (there may be a deadlock).\n"); + warning ("Setting blocking default Gee.HazardPointer.Policy (there may be a deadlock).\n"); AtomicInt.set(ref _default_policy, (int)policy); } @@ -303,7 +303,7 @@ public class Gee.HazardPointer<G> { // FIXME: Make it a struct TRY_FREE, /** * Goes through the free list and attempts to free un-freed elements - * untill all elements are freed. + * until all elements are freed. */ FREE, /** @@ -497,7 +497,7 @@ public class Gee.HazardPointer<G> { // FIXME: Make it a struct policy = AtomicInt.get (ref release_policy); if ((policy & (1 << (sizeof(int) * 8 - 1))) == 0) { _queue = new LinkedList<ArrayList<FreeNode *>> (); - // Hack to not lie about successfull setting policy + // Hack to not lie about successful setting policy policy = AtomicInt.add (ref release_policy, (int)(1 << (sizeof(int) * 8 - 1))); start ((ReleasePolicy) policy); } @@ -589,7 +589,7 @@ public class Gee.HazardPointer<G> { // FIXME: Make it a struct } /** - * Ensure that whole context is freed. Plase note that it might block. + * Ensure that whole context is freed. Please note that it might block. */ public void free_all () { while (HazardPointer.try_free (_to_free)) @@ -608,7 +608,7 @@ public class Gee.HazardPointer<G> { // FIXME: Make it a struct } /** - * Pushes the current context to releaser. Plase note that it might block. + * Pushes the current context to releaser. Please note that it might block. */ public void release () { _queue_mutex.lock (); diff --git a/gee/iterator.vala b/gee/iterator.vala index 99ec295..b0e71b5 100644 --- a/gee/iterator.vala +++ b/gee/iterator.vala @@ -70,13 +70,13 @@ public interface Gee.Iterator<G> : Object, Traversable<G> { public abstract void remove (); /** - * Determines wheather the call to {@link get} is legal. It is false at the + * Determines whether the call to {@link get} is legal. It is false at the * beginning and after {@link remove} call and true otherwise. */ public abstract bool valid { get; } /** - * Determines wheather the call to {@link remove} is legal assuming the + * Determines whether the call to {@link remove} is legal assuming the * iterator is valid. The value must not change in runtime hence the user * of iterator may cache it. */ @@ -94,10 +94,10 @@ public interface Gee.Iterator<G> : Object, Traversable<G> { } /** - * Concatinate iterators. + * Concatenate iterators. * * @param iters Iterators of iterators - * @return Iterator containg values of each iterator + * @return Iterator containing values of each iterator */ public static Iterator<G> concat<G> (Iterator<Iterator<G>> iters) { Iterator<G>? current = null; diff --git a/gee/linkedlist.vala b/gee/linkedlist.vala index 136e35b..aff36b9 100644 --- a/gee/linkedlist.vala +++ b/gee/linkedlist.vala @@ -154,7 +154,7 @@ public class Gee.LinkedList<G> : AbstractBidirList<G>, Queue<G>, Deque<G> { /** * {@inheritDoc} */ - public override bool remove (G item) { // Should remove only the first occurence (a test should be added) + public override bool remove (G item) { // Should remove only the first occurrence (a test should be added) for (weak Node<G> n = this._head; n != null; n = n.next) { if (this.equal_func (item, n.data)) { this._remove_node (n); diff --git a/gee/list.vala b/gee/list.vala index 5f08aba..280c96a 100644 --- a/gee/list.vala +++ b/gee/list.vala @@ -49,10 +49,10 @@ public interface Gee.List<G> : Collection<G> { public abstract void set (int index, G item); /** - * Returns the index of the first occurence of the specified item in + * Returns the index of the first occurrence of the specified item in * this list. * - * @return the index of the first occurence of the specified item, or + * @return the index of the first occurrence of the specified item, or * -1 if the item could not be found */ public abstract int index_of (G item); @@ -77,8 +77,8 @@ public interface Gee.List<G> : Collection<G> { /** * Returns a slice of this list. * - * @param start zero-based index of the begin of the slice - * @param stop zero-based index after the end of the slice + * @param start zero-based index of the slice's first element + * @param stop zero-based index of the position after the end of the slice * * @return A list containing a slice of this list */ diff --git a/gee/map.vala b/gee/map.vala index ae2cdb5..871ca2c 100644 --- a/gee/map.vala +++ b/gee/map.vala @@ -36,7 +36,7 @@ public interface Gee.Map<K,V> : Object, Iterable<Map.Entry<K,V>> { public virtual bool is_empty { get { return size == 0; } } /** - * Specifies whether this collection can change - i.e. wheather {@link set}, + * Specifies whether this collection can change - i.e. whether {@link set}, * {@link remove} etc. are legal operations. */ public abstract bool read_only { get; } @@ -210,7 +210,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. + * Returns ``true`` if this map contains all the same items as the input + * map. * * @param map the map which items will be compared with this map */ @@ -224,7 +225,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. + * Returns ``true`` if this map contains all the same items as the input + * map. * * @param map the map which items will be compared with this map */ diff --git a/gee/mapiterator.vala b/gee/mapiterator.vala index ae83fcf..ca06105 100644 --- a/gee/mapiterator.vala +++ b/gee/mapiterator.vala @@ -84,28 +84,28 @@ public interface Gee.MapIterator<K,V> : Object { public abstract void unset (); /** - * Determines wheather the call to {@link get_key}, {@link get_value} and + * Determines whether the call to {@link get_key}, {@link get_value} and * {@link set_value} is legal. It is false at the beginning and after * {@link unset} call and true otherwise. */ public abstract bool valid { get; } /** - * Determines wheather the call to {@link set_value} is legal assuming the + * Determines whether the call to {@link set_value} is legal assuming the * iterator is valid. The value must not change in runtime hence the user * of iterator may cache it. */ public abstract bool mutable { get; } /** - * Determines wheather the call to {@link unset} is legal assuming the + * Determines whether the call to {@link unset} is legal assuming the * iterator is valid. The value must not change in runtime hence the user * of iterator may cache it. */ public abstract bool read_only { get; } /** - * Standard aggragation function. + * Standard aggregation function. * * It takes a function, seed and first element, returns the new seed and * progress to next element when the operation repeats. diff --git a/gee/multimap.vala b/gee/multimap.vala index 01c158f..e72d8ed 100644 --- a/gee/multimap.vala +++ b/gee/multimap.vala @@ -31,7 +31,7 @@ public interface Gee.MultiMap<K,V> : Object { public abstract int size { get; } /** - * Specifies whether this collection can change - i.e. wheather {@link set}, + * Specifies whether this collection can change - i.e. whether {@link set}, * {@link remove} etc. are legal operations. */ public abstract bool read_only { get; } diff --git a/gee/multiset.vala b/gee/multiset.vala index 0236cea..13ecc9c 100644 --- a/gee/multiset.vala +++ b/gee/multiset.vala @@ -26,11 +26,11 @@ [GenericAccessors] public interface Gee.MultiSet<G> : Collection<G> { /** - * Returns the number of occurences of an item in this multiset. + * Returns the number of occurrences of an item in this multiset. * - * @param item the item to count occurences of + * @param item the item to count occurrences of * - * @return the number of occurences of the item in this multiset. + * @return the number of occurrences of the item in this multiset. */ public abstract int count (G item); diff --git a/gee/queue.vala b/gee/queue.vala index 8de6864..c21e339 100644 --- a/gee/queue.vala +++ b/gee/queue.vala @@ -34,8 +34,8 @@ * because the queue was full or empty. * * Queue implementations are not limited to First-In-First-Out behavior and can - * propose different ordering of their elements. Each Queue implementation have - * to specify how it orders its elements. + * offer different orderings of their elements. Each Queue implementation must + * specify how it orders its elements. * * Queue implementations do not allow insertion of ``null`` elements, although * some implementations, such as {@link LinkedList}, do not prohibit insertion diff --git a/gee/sortedset.vala b/gee/sortedset.vala index d95c792..3e74376 100644 --- a/gee/sortedset.vala +++ b/gee/sortedset.vala @@ -41,7 +41,7 @@ public interface Gee.SortedSet<G> : Gee.Set<G> { public abstract G last (); /** - * Returns a {@link BidirIterator} initialy pointed at the specified + * Returns a {@link BidirIterator} initially pointed at the specified * element. * * @param element the element to point the iterator at diff --git a/gee/task.vala b/gee/task.vala index 80d6dbd..00cf74f 100644 --- a/gee/task.vala +++ b/gee/task.vala @@ -28,7 +28,7 @@ namespace Gee { * of threads from pool will execute the task. * * Note: There is limited number of threads unless environment variable - * ``GEE_NUM_THREADS`` is set to -1. It is not adviced to call I/O or + * ``GEE_NUM_THREADS`` is set to -1. It is not advised to call I/O or * block inside the taks. If necessary it is possible to create a new one * by anyther call. * @@ -51,7 +51,7 @@ namespace Gee { * one of threads from pool will execute the task. * * Note: There is limited number of threads unless environment variable - * ``GEE_NUM_THREADS`` is set to -1. It is not adviced to call I/O or + * ``GEE_NUM_THREADS`` is set to -1. It is not advised to call I/O or * block inside the taks. If necessary it is possible to create a new one * by anyther call. * diff --git a/gee/traversable.vala b/gee/traversable.vala index 9383041..0ad6d78 100644 --- a/gee/traversable.vala +++ b/gee/traversable.vala @@ -52,7 +52,7 @@ namespace Gee { [GenericAccessors] public interface Gee.Traversable<G> : Object { /** - * Apply function to each element returned by iterator untill last element + * Apply function to each element returned by iterator until last element * or function return ''false''. * * ''{@link Iterator} implementation:'' Operation moves the iterator @@ -194,9 +194,9 @@ public interface Gee.Traversable<G> : Object { * * Note: Default implementation uses {@link stream}. * - * Note: When the method is called on {@link Iterator} using the parent - * iterator is not allowed befor the inner iterator - * {@link Iterator.next} return false and then it points on its last + * Note: When the method is called on {@link Iterator}, using the parent + * iterator is not allowed before the inner iterator + * {@link Iterator.next} returns false and then it points to its last * element. The resulting iterator is {@link Iterator.valid}. * * @param f Folding function @@ -235,15 +235,15 @@ public interface Gee.Traversable<G> : Object { } /** - * Creates a new iterator that contains only values that fullfills the + * Creates a new iterator that contains only values that fulfills the * predicate. * * Note: When the method is called on {@link Iterator} using the parent - * iterator is not allowed befor the inner iterator + * iterator is not allowed before the inner iterator * {@link Iterator.next} return false and then it points on its last * element. The resulting iterator is {@link Iterator.valid} if parent * iterator is {@link Iterator.valid} and value it is pointing on - * fullfills the predicate. + * fulfills the predicate. * * @param pred predicate to check should the value be retained * @return Iterator containing values of subsequent values of seed @@ -331,8 +331,8 @@ public interface Gee.Traversable<G> : Object { public virtual Type element_type { get { return typeof (G); } } /** - * A fused concatinate and map. The function is applied to each element - * of iteration and the resulting values are concatinated. + * A fused concatenate and map. The function is applied to each element + * of iteration and the resulting values are concatenated. * * The iterator is lazy evaluated but value is force-evaluated when * iterator is moved to next value. diff --git a/tests/testcollection.vala b/tests/testcollection.vala index c2ce182..e89846b 100644 --- a/tests/testcollection.vala +++ b/tests/testcollection.vala @@ -454,7 +454,7 @@ public abstract class CollectionTests : Gee.TestCase { // Creating a dummy collection var dummy = new ArrayList<string> (); - // Check when both collection are intially empty + // Check when both collection are initially empty assert (! test_collection.remove_all (dummy)); assert (test_collection.is_empty); diff --git a/tests/testlist.vala b/tests/testlist.vala index a2aa923..d493b74 100644 --- a/tests/testlist.vala +++ b/tests/testlist.vala @@ -556,7 +556,7 @@ public abstract class ListTests : CollectionTests { test_list.clear (); dummy.clear (); - // Insert all in the beginnig + // Insert all in the beginning assert (test_list.add ("three")); assert (test_list.add ("four")); assert (test_list.add ("five")); |