[glib] Add note in g_sequence_search() doc about g_sequence_lookup()



commit e666a2ed696a9545a23371b53c4a07471b635d5c
Author: Xavier Claessens <xclaesse gmail com>
Date:   Fri Dec 10 10:17:44 2010 +0100

    Add note in g_sequence_search() doc about g_sequence_lookup()

 glib/gsequence.c |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)
---
diff --git a/glib/gsequence.c b/glib/gsequence.c
index 5a55bee..40b3294 100644
--- a/glib/gsequence.c
+++ b/glib/gsequence.c
@@ -761,6 +761,9 @@ g_sequence_sort_changed (GSequenceIter    *iter,
  * Returns an iterator pointing to the position where @data would
  * be inserted according to @cmp_func and @cmp_data.
  *
+ * If you are simply searching for an existing element of the sequence,
+ * consider using g_sequence_lookup().
+ *
  * Return value: an #GSequenceIter pointing to the position where @data
  * would have been inserted according to @cmp_func and @cmp_data.
  *
@@ -1015,6 +1018,9 @@ g_sequence_insert_sorted_iter (GSequence                *seq,
  * a #GSequenceIterCompareFunc instead of a #GCompareDataFunc as
  * the compare function.
  *
+ * If you are simply searching for an existing element of the sequence,
+ * consider using g_sequence_lookup_iter().
+ *
  * Return value: a #GSequenceIter pointing to the position in @seq
  * where @data would have been inserted according to @iter_cmp and @cmp_data.
  *



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