From: Maciej Piechotka Date: Sat, 12 Feb 2011 01:53:11 +0000 (+0000) Subject: Fix monospace text valadoc markup (replace ` by ``) X-Git-Tag: 0.7.0~30 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=55141e609cae7663d9abdb59d701b2a12f6a3b44;p=platform%2Fupstream%2Flibgee.git Fix monospace text valadoc markup (replace ` by ``) --- diff --git a/gee/bidiriterator.vala b/gee/bidiriterator.vala index 9dd28af..0efbc9c 100644 --- a/gee/bidiriterator.vala +++ b/gee/bidiriterator.vala @@ -27,28 +27,28 @@ public interface Gee.BidirIterator : Gee.Iterator { /** * Rewinds to the previous element in the iteration. * - * @return `true` if the iterator has a previous element + * @return ``true`` if the iterator has a previous element */ public abstract bool previous (); /** * Checks whether there is a previous element in the iteration. * - * @return `true` if the iterator has a previous element + * @return ``true`` if the iterator has a previous element */ public abstract bool has_previous (); /** * Rewinds to the first element in the iteration. * - * @return `true` if the iterator has a first element + * @return ``true`` if the iterator has a first element */ public abstract bool first (); /** * Advances to the last element in the iteration. * - * @return `true` if the iterator has a last element + * @return ``true`` if the iterator has a last element */ public abstract bool last (); } diff --git a/gee/collection.vala b/gee/collection.vala index 5db67fb..063858b 100644 --- a/gee/collection.vala +++ b/gee/collection.vala @@ -45,7 +45,7 @@ public interface Gee.Collection : Iterable { * * @param item the item to locate in the collection * - * @return `true` if item is found, `false` otherwise + * @return ``true`` if item is found, ``false`` otherwise */ public abstract bool contains (G item); @@ -55,7 +55,7 @@ public interface Gee.Collection : Iterable { * * @param item the item to add to the collection * - * @return `true` if the collection has been changed, `false` otherwise + * @return ``true`` if the collection has been changed, ``false`` otherwise */ public abstract bool add (G item); @@ -65,7 +65,7 @@ public interface Gee.Collection : Iterable { * * @param item the item to remove from the collection * - * @return `true` if the collection has been changed, `false` otherwise + * @return ``true`` if the collection has been changed, ``false`` otherwise */ public abstract bool remove (G item); @@ -81,18 +81,18 @@ public interface Gee.Collection : Iterable { * @param collection the collection which items will be added to this * collection. * - * @return `true` if the collection has been changed, `false` otherwise + * @return ``true`` if the collection has been changed, ``false`` otherwise */ public abstract bool add_all (Collection collection); /** - * Returns `true` it this collection contains all items as the input + * Returns ``true`` it this collection contains all items as the input * collection. * * @param collection the collection which items will be compared with * this collection. * - * @return `true` if the collection has been changed, `false` otherwise + * @return ``true`` if the collection has been changed, ``false`` otherwise */ public abstract bool contains_all (Collection collection); @@ -105,7 +105,7 @@ public interface Gee.Collection : Iterable { * @param collection the collection which items will be compared with * this collection. * - * @return `true` if the collection has been changed, `false` otherwise + * @return ``true`` if the collection has been changed, ``false`` otherwise */ public abstract bool remove_all (Collection collection); @@ -117,7 +117,7 @@ public interface Gee.Collection : Iterable { * @param collection the collection which items will be compared with * this collection. * - * @return `true` if the collection has been changed, `false` otherwise + * @return ``true`` if the collection has been changed, ``false`` otherwise */ public abstract bool retain_all (Collection collection); diff --git a/gee/deque.vala b/gee/deque.vala index 953e085..c864a8c 100644 --- a/gee/deque.vala +++ b/gee/deque.vala @@ -52,14 +52,14 @@ public interface Gee.Deque : Queue { * * @param element the element to offer to the queue * - * @return `true` if the element was added to the queue + * @return ``true`` if the element was added to the queue */ public abstract bool offer_head (G element); /** * Peeks (retrieves, but not remove) an element from this queue. * - * @return the element peeked from the queue (or `null` if none was + * @return the element peeked from the queue (or ``null`` if none was * available) */ public abstract G? peek_head (); @@ -67,7 +67,7 @@ public interface Gee.Deque : Queue { /** * Polls (retrieves and remove) an element from the head of this queue. * - * @return the element polled from the queue (or `null` if none was + * @return the element polled from the queue (or ``null`` if none was * available) */ public abstract G? poll_head (); @@ -88,7 +88,7 @@ public interface Gee.Deque : Queue { * * @param element the element to offer to the queue * - * @return `true` if the element was added to the queue + * @return ``true`` if the element was added to the queue */ public abstract bool offer_tail (G element); @@ -96,7 +96,7 @@ public interface Gee.Deque : Queue { * Peeks (retrieves, but not remove) an element from the tail of this * queue. * - * @return the element peeked from the queue (or `null` if none was + * @return the element peeked from the queue (or ``null`` if none was * available) */ public abstract G? peek_tail (); @@ -104,7 +104,7 @@ public interface Gee.Deque : Queue { /** * Polls (retrieves and remove) an element from the tail of this queue. * - * @return the element polled from the queue (or `null` if none was + * @return the element polled from the queue (or ``null`` if none was * available) */ public abstract G? poll_tail (); diff --git a/gee/functions.vala b/gee/functions.vala index 1a5ec54..16f7713 100644 --- a/gee/functions.vala +++ b/gee/functions.vala @@ -30,7 +30,7 @@ namespace Gee { * * With those functions, you can retrieve the equal, hash and compare * functions that best match your element, key or value types. Supported - * types are (non-boxed) primitive, string and `Object` types. + * types are (non-boxed) primitive, string and ``Object`` types. * * A special care is taken for classes inheriting from the * {@link Comparable} interface. For such types, an appropriate compare diff --git a/gee/iterator.vala b/gee/iterator.vala index 541de13..48d50b8 100644 --- a/gee/iterator.vala +++ b/gee/iterator.vala @@ -44,14 +44,14 @@ public interface Gee.Iterator : Object { /** * Advances to the next element in the iteration. * - * @return `true` if the iterator has a next element + * @return ``true`` if the iterator has a next element */ public abstract bool next (); /** * Checks whether there is a next element in the iteration. * - * @return `true` if the iterator has a next element + * @return ``true`` if the iterator has a next element */ public abstract bool has_next (); diff --git a/gee/map.vala b/gee/map.vala index e78bdc7..00e81b2 100644 --- a/gee/map.vala +++ b/gee/map.vala @@ -75,7 +75,7 @@ public interface Gee.Map : Object, Iterable> { * * @param key the key to locate in the map * - * @return `true` if key is found, `false` otherwise + * @return ``true`` if key is found, ``false`` otherwise */ public abstract bool has_key (K key); @@ -84,7 +84,7 @@ public interface Gee.Map : Object, Iterable> { * * @param key the key to locate in the map * - * @return `true` if key is found, `false` otherwise + * @return ``true`` if key is found, ``false`` otherwise * * @deprecated Use {@link has_key} method instead. */ @@ -97,7 +97,7 @@ public interface Gee.Map : Object, Iterable> { * @param key the key to locate in the map * @param value the corresponding value * - * @return `true` if key is found, `false` otherwise + * @return ``true`` if key is found, ``false`` otherwise */ public abstract bool has (K key, V value); @@ -106,7 +106,7 @@ public interface Gee.Map : Object, Iterable> { * * @param key the key whose value is to be retrieved * - * @return the value associated with the key, or `null` if the key + * @return the value associated with the key, or ``null`` if the key * couldn't be found */ public abstract V? get (K key); @@ -125,7 +125,7 @@ public interface Gee.Map : Object, Iterable> { * @param key the key to remove from the map * @param value the receiver variable for the removed value * - * @return `true` if the map has been changed, `false` otherwise + * @return ``true`` if the map has been changed, ``false`` otherwise */ public abstract bool unset (K key, out V? value = null); @@ -135,7 +135,7 @@ public interface Gee.Map : Object, Iterable> { * @param key the key to remove from the map * @param value the receiver variable for the removed value * - * @return `true` if the map has been changed, `false` otherwise + * @return ``true`` if the map has been changed, ``false`` otherwise * * @deprecated Use {@link unset} method instead. */ @@ -182,14 +182,14 @@ public interface Gee.Map : Object, Iterable> { public abstract bool remove_all (Map map); /** - * Returns `true` it this map contains all items as the input map. + * Returns ``true`` it this map contains all items as the input map. * * @param map the map which items will be compared with this map */ public abstract bool has_all (Map map); /** - * Returns `true` it this map contains all items as the input map. + * Returns ``true`` it this map contains all 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 5479e0c..80f94ef 100644 --- a/gee/mapiterator.vala +++ b/gee/mapiterator.vala @@ -42,14 +42,14 @@ public interface Gee.MapIterator : Object { /** * Advances to the next entry in the iteration. * - * @return `true` if the iterator has a next entry + * @return ``true`` if the iterator has a next entry */ public abstract bool next (); /** * Checks whether there is a next entry in the iteration. * - * @return `true` if the iterator has a next entry + * @return ``true`` if the iterator has a next entry */ public abstract bool has_next (); diff --git a/gee/multimap.vala b/gee/multimap.vala index 71e1c2a..373ac08 100644 --- a/gee/multimap.vala +++ b/gee/multimap.vala @@ -61,7 +61,7 @@ public interface Gee.MultiMap : Object { * * @param key the key to locate in the map * - * @return `true` if key is found, `false` otherwise + * @return ``true`` if key is found, ``false`` otherwise */ public abstract bool contains (K key); @@ -88,7 +88,7 @@ public interface Gee.MultiMap : Object { * @param key the key to remove from the map * @param value the value to remove from the map * - * @return `true` if the map has been changed, `false` otherwise + * @return ``true`` if the map has been changed, ``false`` otherwise */ public abstract bool remove (K key, V value); @@ -98,7 +98,7 @@ public interface Gee.MultiMap : Object { * * @param key the key to remove from the map * - * @return `true` if the map has been changed, `false` otherwise + * @return ``true`` if the map has been changed, ``false`` otherwise */ public abstract bool remove_all (K key); diff --git a/gee/queue.vala b/gee/queue.vala index 3464c36..787f80a 100644 --- a/gee/queue.vala +++ b/gee/queue.vala @@ -30,17 +30,17 @@ * * This interface defines methods that will never fail whatever the state of * the queue is. For capacity-bounded queues, those methods will either return - * `false` or `null` to specify that the insert or retrieval did not occur + * ``false`` or ``null`` to specify that the insert or retrieval did not occur * 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. * - * Queue implementations do not allow insertion of `null` elements, although + * Queue implementations do not allow insertion of ``null`` elements, although * some implementations, such as {@link LinkedList}, do not prohibit insertion - * of `null`. Even in the implementations that permit it, `null` should not be - * inserted into a Queue, as `null` is also used as a special return value by + * of ``null``. Even in the implementations that permit it, ``null`` should not be + * inserted into a Queue, as ``null`` is also used as a special return value by * the poll method to indicate that the queue contains no elements. */ public interface Gee.Queue : Collection { @@ -51,12 +51,12 @@ public interface Gee.Queue : Collection { public static const int UNBOUNDED_CAPACITY = -1; /** - * The capacity of this queue (or `null` if capacity is not bound). + * The capacity of this queue (or ``null`` if capacity is not bound). */ public abstract int capacity { get; } /** - * The remaining capacity of this queue (or `null` if capacity is not + * The remaining capacity of this queue (or ``null`` if capacity is not * bound). */ public abstract int remaining_capacity { get; } @@ -71,14 +71,14 @@ public interface Gee.Queue : Collection { * * @param element the element to offer to the queue * - * @return `true` if the element was added to the queue + * @return ``true`` if the element was added to the queue */ public abstract bool offer (G element); /** * Peeks (retrieves, but not remove) an element from this queue. * - * @return the element peeked from the queue (or `null` if none was + * @return the element peeked from the queue (or ``null`` if none was * available) */ public abstract G? peek (); @@ -86,7 +86,7 @@ public interface Gee.Queue : Collection { /** * Polls (retrieves and remove) an element from this queue. * - * @return the element polled from the queue (or `null` if none was + * @return the element polled from the queue (or ``null`` if none was * available) */ public abstract G? poll (); diff --git a/gee/sortedset.vala b/gee/sortedset.vala index 2992859..a8058c3 100644 --- a/gee/sortedset.vala +++ b/gee/sortedset.vala @@ -117,8 +117,8 @@ public interface Gee.SortedSet : Gee.Set { /** * Returns the right-open sub-set of this sorted set, thus containing - * elements equal or higher than the specified `from` element, and stricly - * lower than the specified `to` element. + * elements equal or higher than the specified ``from`` element, and stricly + * lower than the specified ``to`` element. * * @param from the lower inclusive bound for the sub-set * @param to the higher exclusive bound for the sub-set