glib: Add (scope call) to a load of sort/equal callbacks

This fixes a load of g-ir-scanner warnings.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #3037
This commit is contained in:
Philip Withnall 2023-11-29 11:59:47 +00:00
parent d930b9058f
commit d07c59ed4e
15 changed files with 59 additions and 59 deletions

View File

@ -300,7 +300,7 @@ g_cache_remove (GCache *cache,
/**
* g_cache_key_foreach:
* @cache: a #GCache
* @func: the function to call with each #GCache key
* @func: (scope call): the function to call with each #GCache key
* @user_data: user data to pass to the function
*
* Calls the given function for each of the keys in the #GCache.
@ -326,7 +326,7 @@ g_cache_key_foreach (GCache *cache,
/**
* g_cache_value_foreach:
* @cache: a #GCache
* @func: the function to call with each #GCache value
* @func: (scope call): the function to call with each #GCache value
* @user_data: user data to pass to the function
*
* Calls the given function for each of the values in the #GCache.

View File

@ -221,7 +221,7 @@ g_thread_set_priority (GThread *thread,
/**
* g_thread_foreach:
* @thread_func: function to call for all #GThread structures
* @thread_func: (scope call): function to call for all #GThread structures
* @user_data: second argument to @thread_func
*
* Call @thread_func on all #GThreads that have been

View File

@ -2980,7 +2980,7 @@ g_byte_array_remove_range (GByteArray *array,
/**
* g_byte_array_sort:
* @array: a #GByteArray
* @compare_func: comparison function
* @compare_func: (scope call): comparison function
*
* Sorts a byte array, using @compare_func which should be a
* qsort()-style comparison function (returns less than zero for first
@ -3003,7 +3003,7 @@ g_byte_array_sort (GByteArray *array,
/**
* g_byte_array_sort_with_data:
* @array: a #GByteArray
* @compare_func: comparison function
* @compare_func: (scope call): comparison function
* @user_data: data to pass to @compare_func
*
* Like g_byte_array_sort(), but the comparison function takes an extra

View File

@ -276,7 +276,7 @@ g_async_queue_push_unlocked (GAsyncQueue *queue,
* g_async_queue_push_sorted:
* @queue: a #GAsyncQueue
* @data: (not nullable): the @data to push into the @queue
* @func: the #GCompareDataFunc is used to sort @queue
* @func: (scope call): the #GCompareDataFunc is used to sort @queue
* @user_data: user data passed to @func.
*
* Inserts @data into @queue using @func to determine the new
@ -317,7 +317,7 @@ g_async_queue_invert_compare (gpointer v1,
* g_async_queue_push_sorted_unlocked:
* @queue: a #GAsyncQueue
* @data: the data to push into the @queue
* @func: the #GCompareDataFunc is used to sort @queue
* @func: (scope call): the #GCompareDataFunc is used to sort @queue
* @user_data: user data passed to @func.
*
* Inserts @data into @queue using @func to determine the new
@ -672,7 +672,7 @@ g_async_queue_length_unlocked (GAsyncQueue *queue)
/**
* g_async_queue_sort:
* @queue: a #GAsyncQueue
* @func: the #GCompareDataFunc is used to sort @queue
* @func: (scope call): the #GCompareDataFunc is used to sort @queue
* @user_data: user data passed to @func
*
* Sorts @queue using @func.
@ -716,7 +716,7 @@ g_async_queue_sort (GAsyncQueue *queue,
/**
* g_async_queue_sort_unlocked:
* @queue: a #GAsyncQueue
* @func: the #GCompareDataFunc is used to sort @queue
* @func: (scope call): the #GCompareDataFunc is used to sort @queue
* @user_data: user data passed to @func
*
* Sorts @queue using @func.

View File

@ -2019,7 +2019,7 @@ g_hash_table_foreach_remove_or_steal (GHashTable *hash_table,
/**
* g_hash_table_foreach_remove:
* @hash_table: a #GHashTable
* @func: the function to call for each key/value pair
* @func: (scope call): the function to call for each key/value pair
* @user_data: user data to pass to the function
*
* Calls the given function for each key/value pair in the
@ -2047,7 +2047,7 @@ g_hash_table_foreach_remove (GHashTable *hash_table,
/**
* g_hash_table_foreach_steal:
* @hash_table: a #GHashTable
* @func: the function to call for each key/value pair
* @func: (scope call): the function to call for each key/value pair
* @user_data: user data to pass to the function
*
* Calls the given function for each key/value pair in the
@ -2074,7 +2074,7 @@ g_hash_table_foreach_steal (GHashTable *hash_table,
/**
* g_hash_table_foreach:
* @hash_table: a #GHashTable
* @func: the function to call for each key/value pair
* @func: (scope call): the function to call for each key/value pair
* @user_data: user data to pass to the function
*
* Calls the given function for each of the key/value pairs in the
@ -2125,7 +2125,7 @@ g_hash_table_foreach (GHashTable *hash_table,
/**
* g_hash_table_find:
* @hash_table: a #GHashTable
* @predicate: function to test the key/value pairs for a certain property
* @predicate: (scope call): function to test the key/value pairs for a certain property
* @user_data: user data to pass to the function
*
* Calls the given function for key/value pairs in the #GHashTable

View File

@ -587,7 +587,7 @@ g_hook_list_invoke_check (GHookList *hook_list,
* @may_recurse: %TRUE if hooks which are currently running
* (e.g. in another thread) are considered valid. If set to %FALSE,
* these are skipped
* @marshaller: the function to call for each #GHook
* @marshaller: (scope call): the function to call for each #GHook
* @marshal_data: data to pass to @marshaller
*
* Calls a function on each valid #GHook and destroys it if the
@ -637,7 +637,7 @@ g_hook_list_marshal_check (GHookList *hook_list,
* @may_recurse: %TRUE if hooks which are currently running
* (e.g. in another thread) are considered valid. If set to %FALSE,
* these are skipped
* @marshaller: the function to call for each #GHook
* @marshaller: (scope call): the function to call for each #GHook
* @marshal_data: data to pass to @marshaller
*
* Calls a function on each valid #GHook.
@ -795,7 +795,7 @@ g_hook_get (GHookList *hook_list,
* @hook_list: a #GHookList
* @need_valids: %TRUE if #GHook elements which have been destroyed
* should be skipped
* @func: the function to call for each #GHook, which should return
* @func: (scope call): the function to call for each #GHook, which should return
* %TRUE when the #GHook has been found
* @data: the data to pass to @func
*
@ -972,7 +972,7 @@ g_hook_find_func_data (GHookList *hook_list,
* g_hook_insert_sorted:
* @hook_list: a #GHookList
* @hook: the #GHook to insert
* @func: the comparison function used to sort the #GHook elements
* @func: (scope call): the comparison function used to sort the #GHook elements
*
* Inserts a #GHook into a #GHookList, sorted by the given function.
*/

View File

@ -634,7 +634,7 @@ g_list_copy (GList *list)
/**
* g_list_copy_deep:
* @list: a #GList, this must point to the top of the list
* @func: a copy function used to copy every element in the list
* @func: (scope call): a copy function used to copy every element in the list
* @user_data: user data passed to the copy function @func, or %NULL
*
* Makes a full (deep) copy of a #GList.
@ -821,7 +821,7 @@ g_list_find (GList *list,
* g_list_find_custom:
* @list: a #GList, this must point to the top of the list
* @data: user data passed to the function
* @func: the function to call for each element.
* @func: (scope call): the function to call for each element.
* It should return 0 when the desired element is found
*
* Finds an element in a #GList, using a supplied function to
@ -981,7 +981,7 @@ g_list_length (GList *list)
/**
* g_list_foreach:
* @list: a #GList, this must point to the top of the list
* @func: the function to call with each element's data
* @func: (scope call): the function to call with each element's data
* @user_data: user data to pass to the function
*
* Calls a function for each element of a #GList.
@ -1067,7 +1067,7 @@ g_list_insert_sorted_real (GList *list,
* @list: a pointer to a #GList, this must point to the top of the
* already sorted list
* @data: the data for the new element
* @func: the function to compare elements in the list. It should
* @func: (scope call): the function to compare elements in the list. It should
* return a number > 0 if the first parameter comes after the
* second parameter in the sort order.
*
@ -1094,7 +1094,7 @@ g_list_insert_sorted (GList *list,
* @list: a pointer to a #GList, this must point to the top of the
* already sorted list
* @data: the data for the new element
* @func: the function to compare elements in the list. It should
* @func: (scope call): the function to compare elements in the list. It should
* return a number > 0 if the first parameter comes after the
* second parameter in the sort order.
* @user_data: user data to pass to comparison function
@ -1189,7 +1189,7 @@ g_list_sort_real (GList *list,
/**
* g_list_sort:
* @list: a #GList, this must point to the top of the list
* @compare_func: the comparison function used to sort the #GList.
* @compare_func: (scope call): the comparison function used to sort the #GList.
* This function is passed the data from 2 elements of the #GList
* and should return 0 if they are equal, a negative value if the
* first element comes before the second, or a positive value if
@ -1223,7 +1223,7 @@ g_list_sort (GList *list,
/**
* g_list_sort_with_data:
* @list: a #GList, this must point to the top of the list
* @compare_func: comparison function
* @compare_func: (scope call): comparison function
* @user_data: user data to pass to comparison function
*
* Like g_list_sort(), but the comparison function accepts

View File

@ -133,8 +133,8 @@ g_node_unlink (GNode *node)
/**
* g_node_copy_deep:
* @node: a #GNode
* @copy_func: the function which is called to copy the data inside each node,
* or %NULL to use the original data.
* @copy_func: (scope call): the function which is called to copy the data
* inside each node, or %NULL to use the original data.
* @data: data to pass to @copy_func
*
* Recursively copies a #GNode and its data.
@ -775,7 +775,7 @@ g_node_depth_traverse_level (GNode *node,
* depth will not be visited. If max_depth is -1 all nodes in
* the tree are visited. If depth is 1, only the root is visited.
* If depth is 2, the root and its children are visited. And so on.
* @func: the function to call for each visited #GNode
* @func: (scope call): the function to call for each visited #GNode
* @data: user data to pass to the function
*
* Traverses a tree starting at the given root #GNode.
@ -1198,7 +1198,7 @@ g_node_last_sibling (GNode *node)
* @node: a #GNode
* @flags: which types of children are to be visited, one of
* %G_TRAVERSE_ALL, %G_TRAVERSE_LEAVES and %G_TRAVERSE_NON_LEAVES
* @func: the function to call for each visited node
* @func: (scope call): the function to call for each visited node
* @data: user data to pass to the function
*
* Calls a function for each of the children of a #GNode. Note that it

View File

@ -286,7 +286,7 @@ msort_r (void *b, size_t n, size_t s, GCompareDataFunc cmp, void *arg)
* @pbase: (not nullable): start of array to sort
* @total_elems: elements in the array
* @size: size of each element
* @compare_func: function to compare elements
* @compare_func: (scope call): function to compare elements
* @user_data: data to pass to @compare_func
*
* This is just like the standard C qsort() function, but

View File

@ -227,7 +227,7 @@ g_queue_copy (GQueue *queue)
/**
* g_queue_foreach:
* @queue: a #GQueue
* @func: the function to call for each element's data
* @func: (scope call): the function to call for each element's data
* @user_data: user data to pass to @func
*
* Calls @func for each element in the queue passing @user_data to the
@ -281,7 +281,7 @@ g_queue_find (GQueue *queue,
* g_queue_find_custom:
* @queue: a #GQueue
* @data: user data passed to @func
* @func: a #GCompareFunc to call for each element. It should return 0
* @func: (scope call): a #GCompareFunc to call for each element. It should return 0
* when the desired element is found
*
* Finds an element in a #GQueue, using a supplied function to find the
@ -308,7 +308,7 @@ g_queue_find_custom (GQueue *queue,
/**
* g_queue_sort:
* @queue: a #GQueue
* @compare_func: the #GCompareDataFunc used to sort @queue. This function
* @compare_func: (scope call): the #GCompareDataFunc used to sort @queue. This function
* is passed two elements of the queue and should return 0 if they are
* equal, a negative value if the first comes before the second, and
* a positive value if the second comes before the first.
@ -1121,7 +1121,7 @@ g_queue_insert_after_link (GQueue *queue,
* g_queue_insert_sorted:
* @queue: a #GQueue
* @data: the data to insert
* @func: the #GCompareDataFunc used to compare elements in the queue. It is
* @func: (scope call): the #GCompareDataFunc used to compare elements in the queue. It is
* called with two elements of the @queue and @user_data. It should
* return 0 if the elements are equal, a negative value if the first
* element comes before the second, and a positive value if the second

View File

@ -3376,7 +3376,7 @@ g_regex_replace_literal (const GRegex *regex,
* @string_len: the length of @string, in bytes, or -1 if @string is nul-terminated
* @start_position: starting index of the string to match, in bytes
* @match_options: options for the match
* @eval: a function to call for each match
* @eval: (scope call): a function to call for each match
* @user_data: user data to pass to the function
* @error: location to store the error occurring, or %NULL to ignore errors
*

View File

@ -895,7 +895,7 @@ g_scanner_foreach_internal (gpointer _key,
* g_scanner_scope_foreach_symbol:
* @scanner: a #GScanner
* @scope_id: the scope id
* @func: the function to call for each symbol/value pair
* @func: (scope call): the function to call for each symbol/value pair
* @user_data: user data to pass to the function
*
* Calls the given function for each of the symbol/value pairs

View File

@ -255,7 +255,7 @@ g_sequence_free (GSequence *seq)
* g_sequence_foreach_range:
* @begin: a #GSequenceIter
* @end: a #GSequenceIter
* @func: a #GFunc
* @func: (scope call): a #GFunc
* @user_data: user data passed to @func
*
* Calls @func for each item in the range (@begin, @end) passing
@ -297,7 +297,7 @@ g_sequence_foreach_range (GSequenceIter *begin,
/**
* g_sequence_foreach:
* @seq: a #GSequence
* @func: the function to call for each item in @seq
* @func: (scope call): the function to call for each item in @seq
* @user_data: user data passed to @func
*
* Calls @func for each item in the sequence passing @user_data
@ -627,7 +627,7 @@ g_sequence_move_range (GSequenceIter *dest,
/**
* g_sequence_sort:
* @seq: a #GSequence
* @cmp_func: the function used to sort the sequence
* @cmp_func: (scope call): the function used to sort the sequence
* @cmp_data: user data passed to @cmp_func
*
* Sorts @seq using @cmp_func.
@ -659,7 +659,7 @@ g_sequence_sort (GSequence *seq,
* g_sequence_insert_sorted:
* @seq: a #GSequence
* @data: the data to insert
* @cmp_func: the function used to compare items in the sequence
* @cmp_func: (scope call): the function used to compare items in the sequence
* @cmp_data: user data passed to @cmp_func.
*
* Inserts @data into @seq using @cmp_func to determine the new
@ -701,7 +701,7 @@ g_sequence_insert_sorted (GSequence *seq,
/**
* g_sequence_sort_changed:
* @iter: A #GSequenceIter
* @cmp_func: the function used to compare items in the sequence
* @cmp_func: (scope call): the function used to compare items in the sequence
* @cmp_data: user data passed to @cmp_func.
*
* Moves the data pointed to by @iter to a new position as indicated by
@ -742,7 +742,7 @@ g_sequence_sort_changed (GSequenceIter *iter,
* g_sequence_search:
* @seq: a #GSequence
* @data: data for the new item
* @cmp_func: the function used to compare items in the sequence
* @cmp_func: (scope call): the function used to compare items in the sequence
* @cmp_data: user data passed to @cmp_func
*
* Returns an iterator pointing to the position where @data would
@ -786,7 +786,7 @@ g_sequence_search (GSequence *seq,
* g_sequence_lookup:
* @seq: a #GSequence
* @data: data to look up
* @cmp_func: the function used to compare items in the sequence
* @cmp_func: (scope call): the function used to compare items in the sequence
* @cmp_data: user data passed to @cmp_func
*
* Returns an iterator pointing to the position of the first item found
@ -830,7 +830,7 @@ g_sequence_lookup (GSequence *seq,
/**
* g_sequence_sort_iter:
* @seq: a #GSequence
* @cmp_func: the function used to compare iterators in the sequence
* @cmp_func: (scope call): the function used to compare iterators in the sequence
* @cmp_data: user data passed to @cmp_func
*
* Like g_sequence_sort(), but uses a #GSequenceIterCompareFunc instead
@ -884,7 +884,7 @@ g_sequence_sort_iter (GSequence *seq,
/**
* g_sequence_sort_changed_iter:
* @iter: a #GSequenceIter
* @iter_cmp: the function used to compare iterators in the sequence
* @iter_cmp: (scope call): the function used to compare iterators in the sequence
* @cmp_data: user data passed to @cmp_func
*
* Like g_sequence_sort_changed(), but uses
@ -949,7 +949,7 @@ g_sequence_sort_changed_iter (GSequenceIter *iter,
* g_sequence_insert_sorted_iter:
* @seq: a #GSequence
* @data: data for the new item
* @iter_cmp: the function used to compare iterators in the sequence
* @iter_cmp: (scope call): the function used to compare iterators in the sequence
* @cmp_data: user data passed to @iter_cmp
*
* Like g_sequence_insert_sorted(), but uses
@ -1016,7 +1016,7 @@ g_sequence_insert_sorted_iter (GSequence *seq,
* g_sequence_search_iter:
* @seq: a #GSequence
* @data: data for the new item
* @iter_cmp: the function used to compare iterators in the sequence
* @iter_cmp: (scope call): the function used to compare iterators in the sequence
* @cmp_data: user data passed to @iter_cmp
*
* Like g_sequence_search(), but uses a #GSequenceIterCompareFunc
@ -1074,7 +1074,7 @@ g_sequence_search_iter (GSequence *seq,
* g_sequence_lookup_iter:
* @seq: a #GSequence
* @data: data to look up
* @iter_cmp: the function used to compare iterators in the sequence
* @iter_cmp: (scope call): the function used to compare iterators in the sequence
* @cmp_data: user data passed to @iter_cmp
*
* Like g_sequence_lookup(), but uses a #GSequenceIterCompareFunc

View File

@ -521,7 +521,7 @@ g_slist_copy (GSList *list)
/**
* g_slist_copy_deep:
* @list: a #GSList
* @func: a copy function used to copy every element in the list
* @func: (scope call): a copy function used to copy every element in the list
* @user_data: user data passed to the copy function @func, or #NULL
*
* Makes a full (deep) copy of a #GSList.
@ -677,7 +677,7 @@ g_slist_find (GSList *list,
* g_slist_find_custom:
* @list: a #GSList
* @data: user data passed to the function
* @func: the function to call for each element.
* @func: (scope call): the function to call for each element.
* It should return 0 when the desired element is found
*
* Finds an element in a #GSList, using a supplied function to
@ -817,7 +817,7 @@ g_slist_length (GSList *list)
/**
* g_slist_foreach:
* @list: a #GSList
* @func: the function to call with each element's data
* @func: (scope call): the function to call with each element's data
* @user_data: user data to pass to the function
*
* Calls a function for each element of a #GSList.
@ -896,7 +896,7 @@ g_slist_insert_sorted_real (GSList *list,
* g_slist_insert_sorted:
* @list: a #GSList
* @data: the data for the new element
* @func: the function to compare elements in the list.
* @func: (scope call): the function to compare elements in the list.
* It should return a number > 0 if the first parameter
* comes after the second parameter in the sort order.
*
@ -917,7 +917,7 @@ g_slist_insert_sorted (GSList *list,
* g_slist_insert_sorted_with_data:
* @list: a #GSList
* @data: the data for the new element
* @func: the function to compare elements in the list.
* @func: (scope call): the function to compare elements in the list.
* It should return a number > 0 if the first parameter
* comes after the second parameter in the sort order.
* @user_data: data to pass to comparison function
@ -1002,7 +1002,7 @@ g_slist_sort_real (GSList *list,
/**
* g_slist_sort:
* @list: a #GSList
* @compare_func: the comparison function used to sort the #GSList.
* @compare_func: (scope call): the comparison function used to sort the #GSList.
* This function is passed the data from 2 elements of the #GSList
* and should return 0 if they are equal, a negative value if the
* first element comes before the second, or a positive value if
@ -1023,7 +1023,7 @@ g_slist_sort (GSList *list,
/**
* g_slist_sort_with_data:
* @list: a #GSList
* @compare_func: comparison function
* @compare_func: (scope call): comparison function
* @user_data: data to pass to comparison function
*
* Like g_slist_sort(), but the sort function accepts a user data argument.

View File

@ -1106,7 +1106,7 @@ g_tree_lookup_extended (GTree *tree,
/**
* g_tree_foreach:
* @tree: a #GTree
* @func: the function to call for each node visited.
* @func: (scope call): the function to call for each node visited.
* If this function returns %TRUE, the traversal is stopped.
* @user_data: user data to pass to the function
*
@ -1145,7 +1145,7 @@ g_tree_foreach (GTree *tree,
/**
* g_tree_foreach_node:
* @tree: a #GTree
* @func: the function to call for each node visited.
* @func: (scope call): the function to call for each node visited.
* If this function returns %TRUE, the traversal is stopped.
* @user_data: user data to pass to the function
*
@ -1186,7 +1186,7 @@ g_tree_foreach_node (GTree *tree,
/**
* g_tree_traverse:
* @tree: a #GTree
* @traverse_func: the function to call for each node visited. If this
* @traverse_func: (scope call): the function to call for each node visited. If this
* function returns %TRUE, the traversal is stopped.
* @traverse_type: the order in which nodes are visited, one of %G_IN_ORDER,
* %G_PRE_ORDER and %G_POST_ORDER
@ -1246,7 +1246,7 @@ g_tree_traverse (GTree *tree,
/**
* g_tree_search_node:
* @tree: a #GTree
* @search_func: a function used to search the #GTree
* @search_func: (scope call): a function used to search the #GTree
* @user_data: the data passed as the second argument to @search_func
*
* Searches a #GTree using @search_func.
@ -1280,7 +1280,7 @@ g_tree_search_node (GTree *tree,
/**
* g_tree_search:
* @tree: a #GTree
* @search_func: a function used to search the #GTree
* @search_func: (scope call): a function used to search the #GTree
* @user_data: the data passed as the second argument to @search_func
*
* Searches a #GTree using @search_func.