/**
* 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 ();
}
*
* @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);
*
* @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);
*
* @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);
* @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);
* @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);
* @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);
*
* @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 ();
/**
* 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 ();
*
* @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);
* 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 ();
/**
* 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 ();
*
* 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
/**
* 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 ();
*
* @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);
*
* @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.
*/
* @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);
*
* @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);
* @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);
* @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.
*/
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
*
/**
* 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 ();
*
* @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);
* @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);
*
* @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);
*
* 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> {
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; }
*
* @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 ();
/**
* 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 ();
/**
* 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
projects / platform / upstream / libgee.git / commitdiff