Commit bf6c3ea6 authored by Sebastian Dröge's avatar Sebastian Dröge

gst: Add some more gobject-introspection annotations

parent ea36e12b
......@@ -304,7 +304,7 @@ gst_buffer_list_n_groups (GstBufferList * list)
* gst_buffer_list_foreach:
* @list: a #GstBufferList
* @func: (scope call): a #GstBufferListFunc to call
* @user_data: user data passed to @func
* @user_data: (closure): user data passed to @func
*
* Call @func with @data for each buffer in @list.
*
......@@ -785,8 +785,8 @@ gst_buffer_list_iterator_steal (GstBufferListIterator * it)
/**
* gst_buffer_list_iterator_do:
* @it: a #GstBufferListIterator
* @do_func: the function to be called
* @user_data: the gpointer to optional user data.
* @do_func: (scope call): the function to be called
* @user_data: (closure): the gpointer to optional user data.
*
* Calls the given function for the last buffer returned by
* gst_buffer_list_iterator_next(). gst_buffer_list_iterator_next() must have
......
......@@ -42,9 +42,9 @@
/**
* gst_filter_run:
* @list: a linked list
* @func: the function to execute for each item
* @func: (scope call): the function to execute for each item
* @first: flag to stop execution after a successful item
* @user_data: user data
* @user_data: (closure): user data
*
* Iterates over the elements in @list, calling @func with the
* list item data for each item. If @func returns TRUE, @data is
......
......@@ -136,7 +136,7 @@ gst_element_implements_interface (GstElement * element, GType iface_type)
* cast a given object to an interface type, and check whether this
* interface is supported for this specific instance.
*
* Returns: a gpointer to the interface type
* Returns: (transfer none): a gpointer to the interface type
*/
gpointer
......
......@@ -471,8 +471,8 @@ filter_free (GstIteratorFilter * it)
/**
* gst_iterator_filter:
* @it: The #GstIterator to filter
* @func: the compare function to select elements
* @user_data: user data passed to the compare function
* @func: (scope call): the compare function to select elements
* @user_data: (closure): user data passed to the compare function
*
* Create a new iterator from an existing iterator. The new iterator
* will only return those elements that match the given compare function @func.
......@@ -481,7 +481,7 @@ filter_free (GstIteratorFilter * it)
*
* When this iterator is freed, @it will also be freed.
*
* Returns: a new #GstIterator.
* Returns: (transfer full): a new #GstIterator.
*
* MT safe.
*/
......@@ -510,9 +510,9 @@ gst_iterator_filter (GstIterator * it, GCompareFunc func, gpointer user_data)
/**
* gst_iterator_fold:
* @it: The #GstIterator to fold over
* @func: the fold function
* @func: (scope call): the fold function
* @ret: the seed value passed to the fold function
* @user_data: user data passed to the fold function
* @user_data: (closure): user data passed to the fold function
*
* Folds @func over the elements of @iter. That is to say, @func will be called
* as @func (object, @ret, @user_data) for each object in @it. The normal use
......@@ -578,8 +578,8 @@ foreach_fold_func (gpointer item, GValue * unused, ForeachFoldData * data)
/**
* gst_iterator_foreach:
* @it: The #GstIterator to iterate
* @func: the function to call for each element.
* @user_data: user data passed to the function
* @func: (scope call): the function to call for each element.
* @user_data: (closure): user data passed to the function
*
* Iterate over all element of @it and call the given function @func for
* each element. As in gst_iterator_fold(), the refcount of a refcounted
......@@ -630,8 +630,8 @@ find_custom_fold_func (gpointer item, GValue * ret, FindCustomFoldData * data)
/**
* gst_iterator_find_custom:
* @it: The #GstIterator to iterate
* @func: the compare function to use
* @user_data: user data passed to the compare function
* @func: (scope call): the compare function to use
* @user_data: (closure): user data passed to the compare function
*
* Find the first element in @it that matches the compare function @func.
* @func should return 0 when the element is found. As in gst_iterator_fold(),
......@@ -643,7 +643,7 @@ find_custom_fold_func (gpointer item, GValue * ret, FindCustomFoldData * data)
*
* This function will return NULL if an error happened to the iterator.
*
* Returns: The element in the iterator that matches the compare
* Returns: (transfer full): The element in the iterator that matches the compare
* function or NULL when no element matched.
*
* MT safe.
......
......@@ -298,7 +298,7 @@ gst_mini_object_make_writable (GstMiniObject * mini_object)
* of memcpy operations in a pipeline, especially if the miniobject
* is a #GstBuffer.
*
* Returns: the mini-object.
* Returns: (transfer full): the mini-object.
*/
GstMiniObject *
gst_mini_object_ref (GstMiniObject * mini_object)
......
......@@ -606,7 +606,7 @@ gst_registry_remove_feature (GstRegistry * registry, GstPluginFeature * feature)
/**
* gst_registry_plugin_filter:
* @registry: registry to query
* @filter: the filter to use
* @filter: (scope call): the filter to use
* @first: only return first match
* @user_data: (closure): user data passed to the filter function
*
......@@ -726,7 +726,7 @@ gst_registry_get_typefind_factory_list (GstRegistry * registry)
/**
* gst_registry_feature_filter:
* @registry: registry to query
* @filter: the filter to use
* @filter: (scope call): the filter to use
* @first: only return first match
* @user_data: (closure): user data passed to the filter function
*
......
......@@ -1074,7 +1074,7 @@ gst_structure_nth_field_name (const GstStructure * structure, guint index)
/**
* gst_structure_foreach:
* @structure: a #GstStructure
* @func: a function to call for each field
* @func: (scope call): a function to call for each field
* @user_data: (closure): private data
*
* Calls the provided function once for each field in the #GstStructure. The
......@@ -1110,7 +1110,7 @@ gst_structure_foreach (const GstStructure * structure,
/**
* gst_structure_map_in_place:
* @structure: a #GstStructure
* @func: a function to call for each field
* @func: (scope call): a function to call for each field
* @user_data: (closure): private data
*
* Calls the provided function once for each field in the #GstStructure. In
......
......@@ -3945,7 +3945,7 @@ gst_util_get_timestamp (void)
* @array: the sorted input array
* @num_elements: number of elements in the array
* @element_size: size of every element in bytes
* @search_func: function to compare two elements, @search_data will always be passed as second argument
* @search_func: (scope call): function to compare two elements, @search_data will always be passed as second argument
* @mode: search mode that should be used
* @search_data: element that should be found
* @user_data: (closure): data to pass to @search_func
......@@ -3958,7 +3958,7 @@ gst_util_get_timestamp (void)
*
* The complexity of this search function is O(log (num_elements)).
*
* Returns: The address of the found element or %NULL if nothing was found
* Returns: (transfer none): The address of the found element or %NULL if nothing was found
*
* Since: 0.10.23
*/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment