[glib] gsequence: Fix g_sequence_lookup() return value documentation



commit 67694fb35e88dd4254173871ebfd5ef814a2ba59
Author: Rui Matos <tiagomatos gmail com>
Date:   Sat Jan 26 19:08:08 2013 +0100

    gsequence: Fix g_sequence_lookup() return value documentation
    
    Mention that we return NULL if the item we are looking up isn't
    found.

 glib/gsequence.c |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)
---
diff --git a/glib/gsequence.c b/glib/gsequence.c
index 6004120..ec23aca 100644
--- a/glib/gsequence.c
+++ b/glib/gsequence.c
@@ -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
  **/



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