gsequence: Add introspection annotations to Return values

Signed-off-by: Philip Withnall <withnall@endlessm.com>

https://bugzilla.gnome.org/show_bug.cgi?id=786060
This commit is contained in:
Philip Withnall 2017-08-10 12:31:35 +01:00
parent 50eeb24415
commit fac7f2be2e

View File

@ -245,7 +245,7 @@ iter_compare (GSequenceIter *node1,
* be called on all items when the sequence is destroyed and on items that * be called on all items when the sequence is destroyed and on items that
* are removed from the sequence. * are removed from the sequence.
* *
* Returns: a new #GSequence * Returns: (transfer full): a new #GSequence
* *
* Since: 2.14 * Since: 2.14
**/ **/
@ -366,7 +366,7 @@ g_sequence_foreach (GSequence *seq,
* The @begin and @end iterators must both point to the same sequence * The @begin and @end iterators must both point to the same sequence
* and @begin must come before or be equal to @end in the sequence. * and @begin must come before or be equal to @end in the sequence.
* *
* Returns: a #GSequenceIter pointing somewhere in the * Returns: (transfer none): a #GSequenceIter pointing somewhere in the
* (@begin, @end) range * (@begin, @end) range
* *
* Since: 2.14 * Since: 2.14
@ -437,7 +437,7 @@ g_sequence_iter_compare (GSequenceIter *a,
* *
* Adds a new item to the end of @seq. * Adds a new item to the end of @seq.
* *
* Returns: an iterator pointing to the new item * Returns: (transfer none): an iterator pointing to the new item
* *
* Since: 2.14 * Since: 2.14
*/ */
@ -464,7 +464,7 @@ g_sequence_append (GSequence *seq,
* *
* Adds a new item to the front of @seq * Adds a new item to the front of @seq
* *
* Returns: an iterator pointing to the new item * Returns: (transfer none): an iterator pointing to the new item
* *
* Since: 2.14 * Since: 2.14
*/ */
@ -493,7 +493,7 @@ g_sequence_prepend (GSequence *seq,
* *
* Inserts a new item just before the item pointed to by @iter. * Inserts a new item just before the item pointed to by @iter.
* *
* Returns: an iterator pointing to the new item * Returns: (transfer none): an iterator pointing to the new item
* *
* Since: 2.14 * Since: 2.14
*/ */
@ -694,7 +694,7 @@ g_sequence_sort (GSequence *seq,
* if the first item comes before the second, and a positive value * if the first item comes before the second, and a positive value
* if the second item comes before the first. * if the second item comes before the first.
* *
* Returns: a #GSequenceIter pointing to the new item. * Returns: (transfer none): a #GSequenceIter pointing to the new item.
* *
* Since: 2.14 * Since: 2.14
*/ */
@ -776,7 +776,7 @@ g_sequence_sort_changed (GSequenceIter *iter,
* you want to add a large amount of data, call g_sequence_sort() after * you want to add a large amount of data, call g_sequence_sort() after
* doing unsorted insertions. * doing unsorted insertions.
* *
* Returns: an #GSequenceIter pointing to the position where @data * Returns: (transfer none): an #GSequenceIter pointing to the position where @data
* would have been inserted according to @cmp_func and @cmp_data * would have been inserted according to @cmp_func and @cmp_data
* *
* Since: 2.14 * Since: 2.14
@ -823,7 +823,7 @@ g_sequence_search (GSequence *seq,
* you want to add a large amount of data, call g_sequence_sort() after * you want to add a large amount of data, call g_sequence_sort() after
* doing unsorted insertions. * doing unsorted insertions.
* *
* Returns: an #GSequenceIter pointing to the position of the * Returns: (transfer none) (nullable): an #GSequenceIter pointing to the position of the
* first item found equal to @data according to @cmp_func and * first item found equal to @data according to @cmp_func and
* @cmp_data, or %NULL if no such item exists * @cmp_data, or %NULL if no such item exists
* *
@ -984,7 +984,7 @@ g_sequence_sort_changed_iter (GSequenceIter *iter,
* first iterator comes before the second, and a positive value * first iterator comes before the second, and a positive value
* if the second iterator comes before the first. * if the second iterator comes before the first.
* *
* Returns: a #GSequenceIter pointing to the new item * Returns: (transfer none): a #GSequenceIter pointing to the new item
* *
* Since: 2.14 * Since: 2.14
*/ */
@ -1055,7 +1055,7 @@ g_sequence_insert_sorted_iter (GSequence *seq,
* you want to add a large amount of data, call g_sequence_sort() after * you want to add a large amount of data, call g_sequence_sort() after
* doing unsorted insertions. * doing unsorted insertions.
* *
* Returns: a #GSequenceIter pointing to the position in @seq * Returns: (transfer none): a #GSequenceIter pointing to the position in @seq
* where @data would have been inserted according to @iter_cmp * where @data would have been inserted according to @iter_cmp
* and @cmp_data * and @cmp_data
* *
@ -1113,7 +1113,7 @@ g_sequence_search_iter (GSequence *seq,
* you want to add a large amount of data, call g_sequence_sort() after * you want to add a large amount of data, call g_sequence_sort() after
* doing unsorted insertions. * doing unsorted insertions.
* *
* Returns: an #GSequenceIter pointing to the position of * Returns: (transfer none) (nullable): an #GSequenceIter pointing to the position of
* the first item found equal to @data according to @cmp_func * the first item found equal to @data according to @cmp_func
* and @cmp_data, or %NULL if no such item exists * and @cmp_data, or %NULL if no such item exists
* *
@ -1156,7 +1156,7 @@ g_sequence_lookup_iter (GSequence *seq,
* *
* Returns the #GSequence that @iter points into. * Returns the #GSequence that @iter points into.
* *
* Returns: the #GSequence that @iter points into * Returns: (transfer none): the #GSequence that @iter points into
* *
* Since: 2.14 * Since: 2.14
*/ */
@ -1181,7 +1181,7 @@ g_sequence_iter_get_sequence (GSequenceIter *iter)
* *
* Returns the data that @iter points to. * Returns the data that @iter points to.
* *
* Returns: the data that @iter points to * Returns: (transfer none): the data that @iter points to
* *
* Since: 2.14 * Since: 2.14
*/ */
@ -1275,7 +1275,7 @@ g_sequence_is_empty (GSequence *seq)
* *
* Returns the end iterator for @seg * Returns the end iterator for @seg
* *
* Returns: the end iterator for @seq * Returns: (transfer none): the end iterator for @seq
* *
* Since: 2.14 * Since: 2.14
*/ */
@ -1293,7 +1293,7 @@ g_sequence_get_end_iter (GSequence *seq)
* *
* Returns the begin iterator for @seq. * Returns the begin iterator for @seq.
* *
* Returns: the begin iterator for @seq. * Returns: (transfer none): the begin iterator for @seq.
* *
* Since: 2.14 * Since: 2.14
*/ */
@ -1328,7 +1328,7 @@ clamp_position (GSequence *seq,
* Returns the iterator at position @pos. If @pos is negative or larger * Returns the iterator at position @pos. If @pos is negative or larger
* than the number of items in @seq, the end iterator is returned. * than the number of items in @seq, the end iterator is returned.
* *
* Returns: The #GSequenceIter at position @pos * Returns: (transfer none): The #GSequenceIter at position @pos
* *
* Since: 2.14 * Since: 2.14
*/ */
@ -1434,7 +1434,7 @@ g_sequence_iter_get_position (GSequenceIter *iter)
* Returns an iterator pointing to the next position after @iter. * Returns an iterator pointing to the next position after @iter.
* If @iter is the end iterator, the end iterator is returned. * If @iter is the end iterator, the end iterator is returned.
* *
* Returns: a #GSequenceIter pointing to the next position after @iter * Returns: (transfer none): a #GSequenceIter pointing to the next position after @iter
* *
* Since: 2.14 * Since: 2.14
*/ */
@ -1453,7 +1453,7 @@ g_sequence_iter_next (GSequenceIter *iter)
* Returns an iterator pointing to the previous position before @iter. * Returns an iterator pointing to the previous position before @iter.
* If @iter is the begin iterator, the begin iterator is returned. * If @iter is the begin iterator, the begin iterator is returned.
* *
* Returns: a #GSequenceIter pointing to the previous position * Returns: (transfer none): a #GSequenceIter pointing to the previous position
* before @iter * before @iter
* *
* Since: 2.14 * Since: 2.14
@ -1477,7 +1477,7 @@ g_sequence_iter_prev (GSequenceIter *iter)
* the begin iterator is returned. If @iter is closer than @delta positions * the begin iterator is returned. If @iter is closer than @delta positions
* to the end of the sequence, the end iterator is returned. * to the end of the sequence, the end iterator is returned.
* *
* Returns: a #GSequenceIter which is @delta positions away from @iter * Returns: (transfer none): a #GSequenceIter which is @delta positions away from @iter
* *
* Since: 2.14 * Since: 2.14
*/ */