[libgee/0.6] Fix monospace text valadoc markup (replace ` by ``)



commit ce9930cdc3549109a05f1528f6c3f67640b74d77
Author: Maciej Piechotka <uzytkownik2 gmail com>
Date:   Sat Feb 12 01:53:59 2011 +0000

    Fix monospace text valadoc markup (replace ` by ``)

 gee/bidiriterator.vala |    6 +++---
 gee/collection.vala    |   16 ++++++++--------
 gee/deque.vala         |   12 ++++++------
 gee/functions.vala     |    2 +-
 gee/iterator.vala      |    6 +++---
 gee/map.vala           |   16 ++++++++--------
 gee/mapiterator.vala   |    6 +++---
 gee/multimap.vala      |    6 +++---
 gee/queue.vala         |   18 +++++++++---------
 gee/sortedset.vala     |    4 ++--
 10 files changed, 46 insertions(+), 46 deletions(-)
---
diff --git a/gee/bidiriterator.vala b/gee/bidiriterator.vala
index e4cf8d6..03d8ce2 100644
--- a/gee/bidiriterator.vala
+++ b/gee/bidiriterator.vala
@@ -27,21 +27,21 @@ public interface Gee.BidirIterator<G> : Gee.Iterator<G> {
 	/**
 	 * 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 ();
 
 	/**
 	 * 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 cf988c7..3bc12a8 100644
--- a/gee/collection.vala
+++ b/gee/collection.vala
@@ -39,7 +39,7 @@ public interface Gee.Collection<G> : Iterable<G> {
 	 *
 	 * @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);
 
@@ -49,7 +49,7 @@ public interface Gee.Collection<G> : Iterable<G> {
 	 *
 	 * @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);
 
@@ -59,7 +59,7 @@ public interface Gee.Collection<G> : Iterable<G> {
 	 *
 	 * @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);
 
@@ -75,18 +75,18 @@ public interface Gee.Collection<G> : Iterable<G> {
 	 * @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<G> 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<G> collection);
 
@@ -99,7 +99,7 @@ public interface Gee.Collection<G> : Iterable<G> {
 	 * @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<G> collection);
 
@@ -111,7 +111,7 @@ public interface Gee.Collection<G> : Iterable<G> {
 	 * @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<G> 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<G> : Queue<G> {
 	 *
 	 * @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<G> : Queue<G> {
 	/**
 	 * 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<G> : Queue<G> {
 	 *
 	 * @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<G> : Queue<G> {
 	 * 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<G> : Queue<G> {
 	/**
 	 * 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 b7ee46b..8067172 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 56111c4..8b243e6 100644
--- a/gee/iterator.vala
+++ b/gee/iterator.vala
@@ -38,21 +38,21 @@ public interface Gee.Iterator<G> : 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 ();
 
 	/**
 	 * 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 ();
 
diff --git a/gee/map.vala b/gee/map.vala
index 20c9aa2..a2b9a3b 100644
--- a/gee/map.vala
+++ b/gee/map.vala
@@ -69,7 +69,7 @@ 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
+	 * @return    ``true`` if key is found, ``false`` otherwise
 	 */
 	public abstract bool has_key (K key);
 
@@ -78,7 +78,7 @@ 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
+	 * @return    ``true`` if key is found, ``false`` otherwise
 	 *
 	 * @deprecated Use { link has_key} method instead.
 	 */
@@ -91,7 +91,7 @@ public interface Gee.Map<K,V> : Object, Iterable<Map.Entry<K,V>> {
 	 * @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);
 
@@ -100,7 +100,7 @@ public interface Gee.Map<K,V> : Object, Iterable<Map.Entry<K,V>> {
 	 *
 	 * @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);
@@ -119,7 +119,7 @@ public interface Gee.Map<K,V> : Object, Iterable<Map.Entry<K,V>> {
 	 * @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);
 
@@ -129,7 +129,7 @@ public interface Gee.Map<K,V> : Object, Iterable<Map.Entry<K,V>> {
 	 * @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.
 	 */
@@ -176,14 +176,14 @@ public interface Gee.Map<K,V> : Object, Iterable<Map.Entry<K,V>> {
 	public abstract bool remove_all (Map<K,V> 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<K,V> 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 485168a..45c1e5b 100644
--- a/gee/mapiterator.vala
+++ b/gee/mapiterator.vala
@@ -36,21 +36,21 @@ public interface Gee.MapIterator<K,V> : 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 ();
 
 	/**
 	 * Rewinds to the first entry in the iteration.
 	 *
-	 * @return `true` if the iterator has a first entry
+	 * @return ``true`` if the iterator has a first entry
 	 */
 	public abstract bool first ();
 
diff --git a/gee/multimap.vala b/gee/multimap.vala
index d358646..7b4aac2 100644
--- a/gee/multimap.vala
+++ b/gee/multimap.vala
@@ -55,7 +55,7 @@ public interface Gee.MultiMap<K,V> : 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);
 
@@ -82,7 +82,7 @@ public interface Gee.MultiMap<K,V> : 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);
 
@@ -92,7 +92,7 @@ public interface Gee.MultiMap<K,V> : 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<G> : Collection<G> {
@@ -51,12 +51,12 @@ public interface Gee.Queue<G> : Collection<G> {
 	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<G> : Collection<G> {
 	 *
 	 * @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<G> : Collection<G> {
 	/**
 	 * 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<G> : Gee.Set<G> {
 
 	/**
 	 * 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



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]