Add note in g_sequence_search() doc about g_sequence_lookup()
authorXavier Claessens <xclaesse@gmail.com>
Fri, 10 Dec 2010 09:17:44 +0000 (10:17 +0100)
committerXavier Claessens <xclaesse@gmail.com>
Mon, 20 Dec 2010 16:30:58 +0000 (17:30 +0100)
glib/gsequence.c

index 5a55bee..40b3294 100644 (file)
@@ -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.
  *