gsequence: Fix g_sequence_lookup() return value documentation
authorRui Matos <tiagomatos@gmail.com>
Sat, 26 Jan 2013 18:08:08 +0000 (19:08 +0100)
committerRui Matos <tiagomatos@gmail.com>
Sat, 26 Jan 2013 18:12:10 +0000 (19:12 +0100)
Mention that we return NULL if the item we are looking up isn't
found.

glib/gsequence.c

index 6004120..ec23aca 100644 (file)
@@ -829,7 +829,8 @@ g_sequence_search (GSequence        *seq,
  * </para></note>
  *
  * Return value: an #GSequenceIter pointing to the position of the
- *     first item found equal to @data according to @cmp_func and @cmp_data.
+ *     first item found equal to @data according to @cmp_func and
+ *     @cmp_data, or %NULL if no such item exists.
  *
  * Since: 2.28
  **/
@@ -1123,7 +1124,7 @@ g_sequence_search_iter (GSequence                *seq,
  *
  * Return value: an #GSequenceIter pointing to the position of
  *     the first item found equal to @data according to @cmp_func
- *     and @cmp_data.
+ *     and @cmp_data, or %NULL if no such item exists.
  *
  * Since: 2.28
  **/