From 38c07a2d01e88ba3bcf18ca546225862d578a0a0 Mon Sep 17 00:00:00 2001 From: Edward Hervey Date: Thu, 24 Oct 2024 09:17:54 +0200 Subject: [PATCH] all: Fix closure annotations This was misused almost everywhere. See https://gi.readthedocs.io/en/latest/annotations/giannotations.html#support-for-gobject-closures and: https://www.bassi.io/articles/2023/02/20/bindable-api-2023/ Part-of: --- girs/GES-1.0.gir | 18 +++++++------- girs/Gst-1.0.gir | 15 ++++++------ girs/GstGL-1.0.gir | 4 ++-- girs/GstPbutils-1.0.gir | 3 ++- girs/GstRtspServer-1.0.gir | 4 ++-- girs/GstVulkan-1.0.gir | 13 +++++----- .../ges/ges-base-effect.c | 14 +++++------ .../ges/ges-meta-container.c | 6 ++--- .../gst-libs/gst/vulkan/gstvkdevice.c | 5 ++-- .../gst-libs/gst/vulkan/gstvkdisplay.c | 4 ++-- .../gst-libs/gst/vulkan/gstvktrash.c | 4 ++-- .../gst-libs/gst/gl/gstglcontext.c | 4 ++-- .../gst-libs/gst/gl/gstgldisplay.c | 8 +++---- .../gst-libs/gst/gl/gstglwindow.c | 20 ++++++++-------- .../gst-libs/gst/pbutils/install-plugins.c | 5 ++-- .../gst/rtsp-server/rtsp-client.c | 8 +++---- .../gst/rtsp-server/rtsp-session-pool.c | 4 ++-- .../gst/rtsp-server/rtsp-session.c | 4 ++-- .../gst/rtsp-server/rtsp-stream-transport.c | 24 +++++++++---------- .../gst/rtsp-server/rtsp-stream.c | 4 ++-- subprojects/gstreamer/gst/gstbuffer.c | 4 ++-- subprojects/gstreamer/gst/gstbufferlist.c | 4 ++-- subprojects/gstreamer/gst/gstcaps.c | 12 +++++----- subprojects/gstreamer/gst/gstelement.c | 12 +++++----- subprojects/gstreamer/gst/gstiterator.c | 16 ++++++------- subprojects/gstreamer/gst/gstmeta.c | 4 ++-- subprojects/gstreamer/gst/gstpad.c | 12 +++++----- subprojects/gstreamer/gst/gstpromise.c | 4 ++-- subprojects/gstreamer/gst/gstregistry.c | 8 +++---- subprojects/gstreamer/gst/gststructure.c | 24 +++++++++---------- subprojects/gstreamer/gst/gsttaglist.c | 4 ++-- subprojects/gstreamer/gst/gsttaskpool.c | 4 ++-- subprojects/gstreamer/gst/gstutils.c | 5 ++-- .../gstreamer/libs/gst/base/gstcollectpads.c | 8 +++---- 34 files changed, 149 insertions(+), 143 deletions(-) diff --git a/girs/GES-1.0.gir b/girs/GES-1.0.gir index cfa987e9a7..af8abefa19 100644 --- a/girs/GES-1.0.gir +++ b/girs/GES-1.0.gir @@ -1096,16 +1096,16 @@ Note that @effect must not be part of a clip, nor can it have A #GESBaseEffect - - The function to use -for querying how a time is translated from the source coordinates to -the sink coordinates of @effect + + The +function to use for querying how a time is translated from the source +coordinates to the sink coordinates of @effect - The function to use -for querying how a time is translated from the sink coordinates to the -source coordinates of @effect + The +function to use for querying how a time is translated from the sink +coordinates to the source coordinates of @effect @@ -5575,8 +5575,8 @@ fields. - A function to call on each of @container's set -metadata fields + A function to call on each of + @container's set metadata fields diff --git a/girs/Gst-1.0.gir b/girs/Gst-1.0.gir index 9f39007020..2c2f64bf3b 100644 --- a/girs/Gst-1.0.gir +++ b/girs/Gst-1.0.gir @@ -22041,11 +22041,11 @@ MT safe. The #GstIterator to filter - + the compare function to select elements - + user data passed to the compare function @@ -30065,8 +30065,8 @@ MT safe. - #GstPadProbeCallback that will be called with notifications of - the pad state + #GstPadProbeCallback that will be called with + notifications of the pad state @@ -31930,8 +31930,8 @@ event. If @foreach_func returns %FALSE the iteration is immediately stopped. - the #GstPadStickyEventsForeachFunction that - should be called for every event. + the + #GstPadStickyEventsForeachFunction that should be called for every event. @@ -56601,7 +56601,8 @@ element or %NULL if nothing was found - function to compare two elements, @search_data will always be passed as second argument + function to compare two + elements, @search_data will always be passed as second argument diff --git a/girs/GstGL-1.0.gir b/girs/GstGL-1.0.gir index 2695818023..b55654f4ad 100644 --- a/girs/GstGL-1.0.gir +++ b/girs/GstGL-1.0.gir @@ -3206,7 +3206,7 @@ second argument is @data. some data to pass to @compare_func - + a comparison function to run @@ -3335,7 +3335,7 @@ second argument is @data. some data to pass to @compare_func - + a comparison function to run diff --git a/girs/GstPbutils-1.0.gir b/girs/GstPbutils-1.0.gir index a8022fa6b9..15827df078 100644 --- a/girs/GstPbutils-1.0.gir +++ b/girs/GstPbutils-1.0.gir @@ -4506,7 +4506,8 @@ installed but no suitable video decoder and no suitable audio decoder). - the function to call when the installer program returns + the function to call when the + installer program returns diff --git a/girs/GstRtspServer-1.0.gir b/girs/GstRtspServer-1.0.gir index 78c24ef07d..7aa03b02d1 100644 --- a/girs/GstRtspServer-1.0.gir +++ b/girs/GstRtspServer-1.0.gir @@ -10927,7 +10927,7 @@ to a client. This is usually used when sending RTP/RTCP over TCP. a #GstRTSPStreamTransport - + a callback called when RTP should be sent @@ -10983,7 +10983,7 @@ to a client. This is usually used when sending RTP/RTCP over TCP. a #GstRTSPStreamTransport - + a callback called when RTP should be sent diff --git a/girs/GstVulkan-1.0.gir b/girs/GstVulkan-1.0.gir index d32c42d9cc..3f3122d95b 100644 --- a/girs/GstVulkan-1.0.gir +++ b/girs/GstVulkan-1.0.gir @@ -1732,11 +1732,12 @@ only have an effect before the call to gst_vulkan_device_open(). a #GstVulkanDevice - - a #GstVulkanDeviceForEachQueueFunc to run for each #GstVulkanQueue + + a #GstVulkanDeviceForEachQueueFunc + to run for each #GstVulkanQueue - + user data to pass to each call of @func @@ -2106,7 +2107,7 @@ second argument is @data. some data to pass to @compare_func - + a comparison function to run @@ -5546,11 +5547,11 @@ to call when @fence is signalled. a #GstVulkanFence - + a #GstVulkanTrashNotify - + user data for @notify diff --git a/subprojects/gst-editing-services/ges/ges-base-effect.c b/subprojects/gst-editing-services/ges/ges-base-effect.c index 42f42e3c6b..9bcfa4cad5 100644 --- a/subprojects/gst-editing-services/ges/ges-base-effect.c +++ b/subprojects/gst-editing-services/ges/ges-base-effect.c @@ -257,13 +257,13 @@ ges_base_effect_register_time_property (GESBaseEffect * effect, /** * ges_base_effect_set_time_translation_funcs: * @effect: A #GESBaseEffect - * @source_to_sink_func: (nullable) (scope notified): The function to use - * for querying how a time is translated from the source coordinates to - * the sink coordinates of @effect - * @sink_to_source_func: (nullable) (scope notified): The function to use - * for querying how a time is translated from the sink coordinates to the - * source coordinates of @effect - * @user_data: (closure): Data to pass to both @source_to_sink_func and + * @source_to_sink_func: (nullable) (scope notified) (closure user_data): The + * function to use for querying how a time is translated from the source + * coordinates to the sink coordinates of @effect + * @sink_to_source_func: (nullable) (scope notified) (closure user_data): The + * function to use for querying how a time is translated from the sink + * coordinates to the source coordinates of @effect + * @user_data: Data to pass to both @source_to_sink_func and * @sink_to_source_func * @destroy: (destroy user_data) (nullable): Method to call to destroy * @user_data, or %NULL diff --git a/subprojects/gst-editing-services/ges/ges-meta-container.c b/subprojects/gst-editing-services/ges/ges-meta-container.c index 296ee5e873..0def3e62e8 100644 --- a/subprojects/gst-editing-services/ges/ges-meta-container.c +++ b/subprojects/gst-editing-services/ges/ges-meta-container.c @@ -174,9 +174,9 @@ _append_foreach (const GstIdStr * fieldname, const GValue * value, /** * ges_meta_container_foreach: * @container: A #GESMetaContainer - * @func: (scope call): A function to call on each of @container's set - * metadata fields - * @user_data: (closure): User data to send to @func + * @func: (scope call) (closure user_data): A function to call on each of + * @container's set metadata fields +* @user_data: User data to send to @func * * Calls the given function on each of the meta container's set metadata * fields. diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdevice.c b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdevice.c index 04fee59650..477a01fbc3 100644 --- a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdevice.c +++ b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdevice.c @@ -545,8 +545,9 @@ gst_vulkan_device_get_queue (GstVulkanDevice * device, guint32 queue_family, /** * gst_vulkan_device_foreach_queue: * @device: a #GstVulkanDevice - * @func: (scope call): a #GstVulkanDeviceForEachQueueFunc to run for each #GstVulkanQueue - * @user_data: (closure func): user data to pass to each call of @func + * @func: (scope call) (closure user_data): a #GstVulkanDeviceForEachQueueFunc + * to run for each #GstVulkanQueue + * @user_data: user data to pass to each call of @func * * Iterate over each queue family available on #GstVulkanDevice * diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdisplay.c b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdisplay.c index b3a587dcc5..aa7362b2ae 100644 --- a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdisplay.c +++ b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvkdisplay.c @@ -394,8 +394,8 @@ window_weak_list_to_strong (GstVulkanDisplay * display) /** * gst_vulkan_display_find_window: * @display: a #GstVulkanDisplay - * @data: (closure): some data to pass to @compare_func - * @compare_func: (scope call): a comparison function to run + * @data: some data to pass to @compare_func + * @compare_func: (scope call) (closure data): a comparison function to run * * Execute @compare_func over the list of windows stored by @display. The * first argument to @compare_func is the #GstVulkanWindow being checked and the diff --git a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvktrash.c b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvktrash.c index c7a0314604..61c848498c 100644 --- a/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvktrash.c +++ b/subprojects/gst-plugins-bad/gst-libs/gst/vulkan/gstvktrash.c @@ -118,8 +118,8 @@ gst_vulkan_trash_init (GstVulkanTrash * trash, GstVulkanFence * fence, /** * gst_vulkan_trash_new: * @fence: a #GstVulkanFence - * @notify: (scope async): a #GstVulkanTrashNotify - * @user_data: (closure notify): user data for @notify + * @notify: (scope async) (closure user_data): a #GstVulkanTrashNotify + * @user_data: user data for @notify * * Create and return a new #GstVulkanTrash object that will stores a callback * to call when @fence is signalled. diff --git a/subprojects/gst-plugins-base/gst-libs/gst/gl/gstglcontext.c b/subprojects/gst-plugins-base/gst-libs/gst/gl/gstglcontext.c index dcd6b6d512..64603649e3 100644 --- a/subprojects/gst-plugins-base/gst-libs/gst/gl/gstglcontext.c +++ b/subprojects/gst-plugins-base/gst-libs/gst/gl/gstglcontext.c @@ -1643,8 +1643,8 @@ _gst_gl_context_thread_run_generic (RunGenericData * data) /** * gst_gl_context_thread_add: * @context: a #GstGLContext - * @func: (scope call): a #GstGLContextThreadFunc - * @data: (closure): user data to call @func with + * @func: (scope call) (closure data): a #GstGLContextThreadFunc + * @data: user data to call @func with * * Execute @func in the OpenGL thread of @context with @data * diff --git a/subprojects/gst-plugins-base/gst-libs/gst/gl/gstgldisplay.c b/subprojects/gst-plugins-base/gst-libs/gst/gl/gstgldisplay.c index 71c12cf7c6..d33891da8e 100644 --- a/subprojects/gst-plugins-base/gst-libs/gst/gl/gstgldisplay.c +++ b/subprojects/gst-plugins-base/gst-libs/gst/gl/gstgldisplay.c @@ -740,8 +740,8 @@ gst_gl_display_remove_window (GstGLDisplay * display, GstGLWindow * window) /** * gst_gl_display_find_window: * @display: a #GstGLDisplay - * @data: (closure): some data to pass to @compare_func - * @compare_func: (scope call): a comparison function to run + * @data: some data to pass to @compare_func + * @compare_func: (scope call) (closure data): a comparison function to run * * Execute @compare_func over the list of windows stored by @display. The * first argument to @compare_func is the #GstGLWindow being checked and the @@ -770,8 +770,8 @@ gst_gl_display_find_window (GstGLDisplay * display, gpointer data, /** * gst_gl_display_retrieve_window: * @display: a #GstGLDisplay - * @data: (closure): some data to pass to @compare_func - * @compare_func: (scope call): a comparison function to run + * @data: some data to pass to @compare_func + * @compare_func: (scope call) (closure data): a comparison function to run * * Execute @compare_func over the list of windows stored by @display. The * first argument to @compare_func is the #GstGLWindow being checked and the diff --git a/subprojects/gst-plugins-base/gst-libs/gst/gl/gstglwindow.c b/subprojects/gst-plugins-base/gst-libs/gst/gl/gstglwindow.c index a6f95b17af..0b4171c77a 100644 --- a/subprojects/gst-plugins-base/gst-libs/gst/gl/gstglwindow.c +++ b/subprojects/gst-plugins-base/gst-libs/gst/gl/gstglwindow.c @@ -669,8 +669,8 @@ gst_gl_window_default_send_message (GstGLWindow * window, /** * gst_gl_window_send_message: * @window: a #GstGLWindow - * @callback: (scope async): function to invoke - * @data: (closure): data to invoke @callback with + * @callback: (scope async) (closure data): function to invoke + * @data: data to invoke @callback with * * Invoke @callback with data on the window thread. @callback is guaranteed to * have executed when this function returns. @@ -759,8 +759,8 @@ gst_gl_window_has_output_surface (GstGLWindow * window) /** * gst_gl_window_send_message_async: * @window: a #GstGLWindow - * @callback: (scope async): function to invoke - * @data: (closure): data to invoke @callback with + * @callback: (scope async) (closure data): function to invoke + * @data: data to invoke @callback with * @destroy: called when @data is not needed anymore * * Invoke @callback with @data on the window thread. The callback may not @@ -785,8 +785,8 @@ gst_gl_window_send_message_async (GstGLWindow * window, GstGLWindowCB callback, /** * gst_gl_window_set_draw_callback: * @window: a #GstGLWindow - * @callback: (scope notified): function to invoke - * @data: (closure): data to invoke @callback with + * @callback: (scope notified) (closure data): function to invoke + * @data: data to invoke @callback with * @destroy_notify: called when @data is not needed any more * * Sets the draw callback called every time gst_gl_window_draw() is called @@ -814,8 +814,8 @@ gst_gl_window_set_draw_callback (GstGLWindow * window, GstGLWindowCB callback, /** * gst_gl_window_set_resize_callback: * @window: a #GstGLWindow - * @callback: (scope notified): function to invoke - * @data: (closure): data to invoke @callback with + * @callback: (scope notified) (closure data): function to invoke + * @data: data to invoke @callback with * @destroy_notify: called when @data is not needed any more * * Sets the resize callback called every time a resize of the window occurs. @@ -843,8 +843,8 @@ gst_gl_window_set_resize_callback (GstGLWindow * window, /** * gst_gl_window_set_close_callback: * @window: a #GstGLWindow - * @callback: (scope notified): function to invoke - * @data: (closure): data to invoke @callback with + * @callback: (scope notified) (closure data): function to invoke + * @data: data to invoke @callback with * @destroy_notify: called when @data is not needed any more * * Sets the callback called when the window is about to close. diff --git a/subprojects/gst-plugins-base/gst-libs/gst/pbutils/install-plugins.c b/subprojects/gst-plugins-base/gst-libs/gst/pbutils/install-plugins.c index 2b811278e1..d4bb1a27e7 100644 --- a/subprojects/gst-plugins-base/gst-libs/gst/pbutils/install-plugins.c +++ b/subprojects/gst-plugins-base/gst-libs/gst/pbutils/install-plugins.c @@ -633,8 +633,9 @@ gst_install_plugins_installer_exited (GPid pid, gint status, gpointer data) * @details: (array zero-terminated=1) (transfer none): NULL-terminated array * of installer string details (see below) * @ctx: (allow-none): a #GstInstallPluginsContext, or NULL - * @func: (scope async): the function to call when the installer program returns - * @user_data: (closure): the user data to pass to @func when called, or NULL + * @func: (scope async) (closure user_data): the function to call when the + * installer program returns + * @user_data: the user data to pass to @func when called, or NULL * * Requests plugin installation without blocking. Once the plugins have been * installed or installation has failed, @func will be called with the result diff --git a/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-client.c b/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-client.c index 66bc5322f7..134f3dae85 100644 --- a/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-client.c +++ b/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-client.c @@ -4728,8 +4728,8 @@ gst_rtsp_client_get_connection (GstRTSPClient * client) /** * gst_rtsp_client_set_send_func: * @client: a #GstRTSPClient - * @func: (scope notified): a #GstRTSPClientSendFunc - * @user_data: (closure): user data passed to @func + * @func: (scope notified) (closure user_data): a #GstRTSPClientSendFunc + * @user_data: user data passed to @func * @notify: (allow-none): called when @user_data is no longer in use * * Set @func as the callback that will be called when a new message needs to be @@ -4770,8 +4770,8 @@ gst_rtsp_client_set_send_func (GstRTSPClient * client, /** * gst_rtsp_client_set_send_messages_func: * @client: a #GstRTSPClient - * @func: (scope notified): a #GstRTSPClientSendMessagesFunc - * @user_data: (closure): user data passed to @func + * @func: (scope notified) (closure user_data): a #GstRTSPClientSendMessagesFunc + * @user_data: user data passed to @func * @notify: (allow-none): called when @user_data is no longer in use * * Set @func as the callback that will be called when new messages needs to be diff --git a/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-session-pool.c b/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-session-pool.c index e55c49fdff..e0ba417e3e 100644 --- a/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-session-pool.c +++ b/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-session-pool.c @@ -539,8 +539,8 @@ gst_rtsp_session_pool_cleanup (GstRTSPSessionPool * pool) /** * gst_rtsp_session_pool_filter: * @pool: a #GstRTSPSessionPool - * @func: (scope call) (allow-none): a callback - * @user_data: (closure): user data passed to @func + * @func: (scope call) (allow-none) (closure user_data): a callback + * @user_data: user data passed to @func * * Call @func for each session in @pool. The result value of @func determines * what happens to the session. @func will be called with the session pool diff --git a/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-session.c b/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-session.c index 2f51120840..9a04e8ec9d 100644 --- a/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-session.c +++ b/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-session.c @@ -425,8 +425,8 @@ gst_rtsp_session_dup_media (GstRTSPSession * sess, const gchar * path, /** * gst_rtsp_session_filter: * @sess: a #GstRTSPSession - * @func: (scope call) (allow-none): a callback - * @user_data: (closure): user data passed to @func + * @func: (scope call) (allow-none) (closure user_data): a callback + * @user_data: user data passed to @func * * Call @func for each media in @sess. The result value of @func determines * what happens to the media. @func will be called with @sess diff --git a/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-stream-transport.c b/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-stream-transport.c index 39d2d84a00..a2aac3d1e9 100644 --- a/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-stream-transport.c +++ b/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-stream-transport.c @@ -225,9 +225,9 @@ gst_rtsp_stream_transport_get_stream (GstRTSPStreamTransport * trans) /** * gst_rtsp_stream_transport_set_callbacks: * @trans: a #GstRTSPStreamTransport - * @send_rtp: (scope notified): a callback called when RTP should be sent - * @send_rtcp: (scope notified): a callback called when RTCP should be sent - * @user_data: (closure): user data passed to callbacks + * @send_rtp: (scope notified) (closure user_data): a callback called when RTP should be sent + * @send_rtcp: (scope notified) (closure user_data): a callback called when RTCP should be sent + * @user_data: user data passed to callbacks * @notify: (allow-none): called with the user_data when no longer needed. * * Install callbacks that will be called when data for a stream should be sent @@ -255,9 +255,9 @@ gst_rtsp_stream_transport_set_callbacks (GstRTSPStreamTransport * trans, /** * gst_rtsp_stream_transport_set_list_callbacks: * @trans: a #GstRTSPStreamTransport - * @send_rtp_list: (scope notified): a callback called when RTP should be sent - * @send_rtcp_list: (scope notified): a callback called when RTCP should be sent - * @user_data: (closure): user data passed to callbacks + * @send_rtp_list: (scope notified) (closure user_data): a callback called when RTP should be sent + * @send_rtcp_list: (scope notified) (closure user_data): a callback called when RTCP should be sent + * @user_data: user data passed to callbacks * @notify: (allow-none): called with the user_data when no longer needed. * * Install callbacks that will be called when data for a stream should be sent @@ -326,8 +326,8 @@ gst_rtsp_stream_transport_check_back_pressure (GstRTSPStreamTransport * trans, /** * gst_rtsp_stream_transport_set_keepalive: * @trans: a #GstRTSPStreamTransport - * @keep_alive: (scope notified): a callback called when the receiver is active - * @user_data: (closure): user data passed to callback + * @keep_alive: (scope notified) (closure user_data): a callback called when the receiver is active + * @user_data: user data passed to callback * @notify: (allow-none): called with the user_data when no longer needed. * * Install callbacks that will be called when RTCP packets are received from the @@ -353,8 +353,8 @@ gst_rtsp_stream_transport_set_keepalive (GstRTSPStreamTransport * trans, /** * gst_rtsp_stream_transport_set_message_sent: * @trans: a #GstRTSPStreamTransport - * @message_sent: (scope notified): a callback called when a message has been sent - * @user_data: (closure): user data passed to callback + * @message_sent: (scope notified) (closure user_data): a callback called when a message has been sent + * @user_data: user data passed to callback * @notify: (allow-none): called with the user_data when no longer needed * * Install a callback that will be called when a message has been sent on @trans. @@ -380,8 +380,8 @@ gst_rtsp_stream_transport_set_message_sent (GstRTSPStreamTransport * trans, /** * gst_rtsp_stream_transport_set_message_sent_full: * @trans: a #GstRTSPStreamTransport - * @message_sent: (scope notified): a callback called when a message has been sent - * @user_data: (closure): user data passed to callback + * @message_sent: (scope notified) (closure user_data): a callback called when a message has been sent + * @user_data: user data passed to callback * @notify: (allow-none): called with the user_data when no longer needed * * Install a callback that will be called when a message has been sent on @trans. diff --git a/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-stream.c b/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-stream.c index 3b600df56e..2082ebc0cc 100644 --- a/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-stream.c +++ b/subprojects/gst-rtsp-server/gst/rtsp-server/rtsp-stream.c @@ -5233,8 +5233,8 @@ gst_rtsp_stream_get_current_seqnum (GstRTSPStream * stream) /** * gst_rtsp_stream_transport_filter: * @stream: a #GstRTSPStream - * @func: (scope call) (allow-none): a callback - * @user_data: (closure): user data passed to @func + * @func: (scope call) (allow-none) (closure user_data): a callback + * @user_data: user data passed to @func * * Call @func for each transport managed by @stream. The result value of @func * determines what happens to the transport. @func will be called with @stream diff --git a/subprojects/gstreamer/gst/gstbuffer.c b/subprojects/gstreamer/gst/gstbuffer.c index bcd55d21b4..807b95847f 100644 --- a/subprojects/gstreamer/gst/gstbuffer.c +++ b/subprojects/gstreamer/gst/gstbuffer.c @@ -2490,8 +2490,8 @@ gst_buffer_iterate_meta_filtered (GstBuffer * buffer, gpointer * state, /** * gst_buffer_foreach_meta: * @buffer: a #GstBuffer - * @func: (scope call): a #GstBufferForeachMetaFunc to call - * @user_data: (closure): user data passed to @func + * @func: (scope call) (closure user_data): a #GstBufferForeachMetaFunc to call + * @user_data: user data passed to @func * * Calls @func with @user_data for each meta in @buffer. * diff --git a/subprojects/gstreamer/gst/gstbufferlist.c b/subprojects/gstreamer/gst/gstbufferlist.c index 946747cf80..a75fc3c07e 100644 --- a/subprojects/gstreamer/gst/gstbufferlist.c +++ b/subprojects/gstreamer/gst/gstbufferlist.c @@ -223,8 +223,8 @@ gst_buffer_list_remove_range_internal (GstBufferList * list, guint idx, /** * gst_buffer_list_foreach: * @list: a #GstBufferList - * @func: (scope call): a #GstBufferListFunc to call - * @user_data: (closure): user data passed to @func + * @func: (scope call) (closure user_data): a #GstBufferListFunc to call + * @user_data: user data passed to @func * * Calls @func with @data for each buffer in @list. * diff --git a/subprojects/gstreamer/gst/gstcaps.c b/subprojects/gstreamer/gst/gstcaps.c index 3faf0b34cd..19861dab9a 100644 --- a/subprojects/gstreamer/gst/gstcaps.c +++ b/subprojects/gstreamer/gst/gstcaps.c @@ -2902,8 +2902,8 @@ gst_caps_transform_to_string (const GValue * src_value, GValue * dest_value) /** * gst_caps_foreach: * @caps: a #GstCaps - * @func: (scope call): a function to call for each field - * @user_data: (closure): private data + * @func: (scope call) (closure user_data): a function to call for each field + * @user_data: private data * * Calls the provided function once for each structure and caps feature in the * #GstCaps. The function must not modify the fields. @@ -2943,8 +2943,8 @@ gst_caps_foreach (const GstCaps * caps, GstCapsForeachFunc func, /** * gst_caps_map_in_place: * @caps: a #GstCaps - * @func: (scope call): a function to call for each field - * @user_data: (closure): private data + * @func: (scope call) (closure user_data): a function to call for each field + * @user_data: private data * * Calls the provided function once for each structure and caps feature in the * #GstCaps. In contrast to gst_caps_foreach(), the function may modify but not @@ -2991,8 +2991,8 @@ gst_caps_map_in_place (GstCaps * caps, GstCapsMapFunc func, gpointer user_data) /** * gst_caps_filter_and_map_in_place: * @caps: a #GstCaps - * @func: (scope call): a function to call for each field - * @user_data: (closure): private data + * @func: (scope call) (closure user_data): a function to call for each field + * @user_data: private data * * Calls the provided function once for each structure and caps feature in the * #GstCaps. In contrast to gst_caps_foreach(), the function may modify the diff --git a/subprojects/gstreamer/gst/gstelement.c b/subprojects/gstreamer/gst/gstelement.c index b81431a774..61c5c9056d 100644 --- a/subprojects/gstreamer/gst/gstelement.c +++ b/subprojects/gstreamer/gst/gstelement.c @@ -1423,8 +1423,8 @@ gst_element_do_foreach_pad (GstElement * element, /** * gst_element_foreach_sink_pad: * @element: a #GstElement to iterate sink pads of - * @func: (scope call): function to call for each sink pad - * @user_data: (closure): user data passed to @func + * @func: (scope call) (closure user_data): function to call for each sink pad + * @user_data: user data passed to @func * * Call @func with @user_data for each of @element's sink pads. @func will be * called exactly once for each sink pad that exists at the time of this call, @@ -1449,8 +1449,8 @@ gst_element_foreach_sink_pad (GstElement * element, /** * gst_element_foreach_src_pad: * @element: a #GstElement to iterate source pads of - * @func: (scope call): function to call for each source pad - * @user_data: (closure): user data passed to @func + * @func: (scope call) (closure user_data): function to call for each source pad + * @user_data: user data passed to @func * * Call @func with @user_data for each of @element's source pads. @func will be * called exactly once for each source pad that exists at the time of this call, @@ -1475,8 +1475,8 @@ gst_element_foreach_src_pad (GstElement * element, /** * gst_element_foreach_pad: * @element: a #GstElement to iterate pads of - * @func: (scope call): function to call for each pad - * @user_data: (closure): user data passed to @func + * @func: (scope call) (closure user_data): function to call for each pad + * @user_data: user data passed to @func * * Call @func with @user_data for each of @element's pads. @func will be called * exactly once for each pad that exists at the time of this call, unless diff --git a/subprojects/gstreamer/gst/gstiterator.c b/subprojects/gstreamer/gst/gstiterator.c index b661aadc65..870f5807d3 100644 --- a/subprojects/gstreamer/gst/gstiterator.c +++ b/subprojects/gstreamer/gst/gstiterator.c @@ -528,8 +528,8 @@ filter_free (GstIteratorFilter * it) /** * gst_iterator_filter: * @it: The #GstIterator to filter - * @func: (scope call): the compare function to select elements - * @user_data: (closure): user data passed to the compare function + * @func: (scope call) (closure user_data): the compare function to select elements + * @user_data: 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. @@ -578,9 +578,9 @@ gst_iterator_filter (GstIterator * it, GCompareFunc func, /** * gst_iterator_fold: * @it: The #GstIterator to fold over - * @func: (scope call): the fold function + * @func: (scope call) (closure user_data): the fold function * @ret: the seed value passed to the fold function - * @user_data: (closure): user data passed to the fold function + * @user_data: 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 @@ -651,8 +651,8 @@ foreach_fold_func (const GValue * item, GValue * unused, ForeachFoldData * data) /** * gst_iterator_foreach: * @it: The #GstIterator to iterate - * @func: (scope call): the function to call for each element. - * @user_data: (closure): user data passed to the function + * @func: (scope call) (closure user_data): the function to call for each element. + * @user_data: user data passed to the function * * Iterate over all element of @it and call the given function @func for * each element. @@ -698,9 +698,9 @@ find_custom_fold_func (const GValue * item, GValue * ret, /** * gst_iterator_find_custom: * @it: The #GstIterator to iterate - * @func: (scope call): the compare function to use + * @func: (scope call) (closure user_data): the compare function to use * @elem: (out): pointer to a #GValue where to store the result - * @user_data: (closure): user data passed to the compare function + * @user_data: 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. The first parameter diff --git a/subprojects/gstreamer/gst/gstmeta.c b/subprojects/gstreamer/gst/gstmeta.c index e542b36ad7..96b273e5d5 100644 --- a/subprojects/gstreamer/gst/gstmeta.c +++ b/subprojects/gstreamer/gst/gstmeta.c @@ -273,8 +273,8 @@ gst_custom_meta_has_name (GstCustomMeta * meta, const gchar * name) * gst_meta_register_custom: * @name: the name of the #GstMeta implementation * @tags: (array zero-terminated=1): tags for @api - * @transform_func: (scope notified) (nullable): a #GstMetaTransformFunction - * @user_data: (closure): user data passed to @transform_func + * @transform_func: (scope notified) (nullable) (closure user_data): a #GstMetaTransformFunction + * @user_data: user data passed to @transform_func * @destroy_data: #GDestroyNotify for user_data * * Register a new custom #GstMeta implementation, backed by an opaque diff --git a/subprojects/gstreamer/gst/gstpad.c b/subprojects/gstreamer/gst/gstpad.c index 7c159d2816..bf08b78ad0 100644 --- a/subprojects/gstreamer/gst/gstpad.c +++ b/subprojects/gstreamer/gst/gstpad.c @@ -1408,9 +1408,9 @@ cleanup_hook (GstPad * pad, GHook * hook) * gst_pad_add_probe: * @pad: the #GstPad to add the probe to * @mask: the probe mask - * @callback: #GstPadProbeCallback that will be called with notifications of - * the pad state - * @user_data: (closure): user data passed to the callback + * @callback: (closure user_data): #GstPadProbeCallback that will be called with + * notifications of the pad state + * @user_data: user data passed to the callback * @destroy_data: #GDestroyNotify for user_data * * Be notified of different states of pads. The provided callback is called for @@ -6270,9 +6270,9 @@ foreach_dispatch_function (GstPad * pad, PadEvent * ev, gpointer user_data) /** * gst_pad_sticky_events_foreach: * @pad: the #GstPad that should be used for iteration. - * @foreach_func: (scope call): the #GstPadStickyEventsForeachFunction that - * should be called for every event. - * @user_data: (closure): the optional user data. + * @foreach_func: (scope call) (closure user_data): the + * #GstPadStickyEventsForeachFunction that should be called for every event. + * @user_data: the optional user data. * * Iterates all sticky events on @pad and calls @foreach_func for every * event. If @foreach_func returns %FALSE the iteration is immediately stopped. diff --git a/subprojects/gstreamer/gst/gstpromise.c b/subprojects/gstreamer/gst/gstpromise.c index 6e0e3eb39d..97a9b1ed1e 100644 --- a/subprojects/gstreamer/gst/gstpromise.c +++ b/subprojects/gstreamer/gst/gstpromise.c @@ -381,8 +381,8 @@ gst_promise_new (void) /** * gst_promise_new_with_change_func: - * @func: (scope notified): a #GstPromiseChangeFunc to call - * @user_data: (closure): argument to call @func with + * @func: (scope notified) (closure user_data): a #GstPromiseChangeFunc to call + * @user_data: argument to call @func with * @notify: notification function that @user_data is no longer needed * * @func will be called exactly once when transitioning out of diff --git a/subprojects/gstreamer/gst/gstregistry.c b/subprojects/gstreamer/gst/gstregistry.c index 2226d1853f..6d06606e2e 100644 --- a/subprojects/gstreamer/gst/gstregistry.c +++ b/subprojects/gstreamer/gst/gstregistry.c @@ -644,9 +644,9 @@ gst_registry_remove_feature (GstRegistry * registry, GstPluginFeature * feature) /** * gst_registry_plugin_filter: * @registry: registry to query - * @filter: (scope call): the filter to use + * @filter: (scope call) (closure user_data): the filter to use * @first: only return first match - * @user_data: (closure): user data passed to the filter function + * @user_data: user data passed to the filter function * * Runs a filter against all plugins in the registry and returns a #GList with * the results. If the first flag is set, only the first match is @@ -823,9 +823,9 @@ gst_registry_get_device_provider_factory_list (GstRegistry * registry) /** * gst_registry_feature_filter: * @registry: registry to query - * @filter: (scope call): the filter to use + * @filter: (scope call) (closure user_data): the filter to use * @first: only return first match - * @user_data: (closure): user data passed to the filter function + * @user_data: user data passed to the filter function * * Runs a filter against all features of the plugins in the registry * and returns a GList with the results. diff --git a/subprojects/gstreamer/gst/gststructure.c b/subprojects/gstreamer/gst/gststructure.c index 1b1288d7bf..e0494f052d 100644 --- a/subprojects/gstreamer/gst/gststructure.c +++ b/subprojects/gstreamer/gst/gststructure.c @@ -2148,8 +2148,8 @@ foreach_quark_adapter (const GstIdStr * fieldname, const GValue * value, /** * gst_structure_foreach: * @structure: a #GstStructure - * @func: (scope call): a function to call for each field - * @user_data: (closure): private data + * @func: (scope call) (closure user_data): a function to call for each field + * @user_data: private data * * Calls the provided function once for each field in the #GstStructure. The * function must not modify the fields. Also see gst_structure_map_in_place() @@ -2188,8 +2188,8 @@ map_in_place_quark_adapter (const GstIdStr * fieldname, GValue * value, /** * gst_structure_map_in_place: * @structure: a #GstStructure - * @func: (scope call): a function to call for each field - * @user_data: (closure): private data + * @func: (scope call) (closure user_data): a function to call for each field + * @user_data: private data * * Calls the provided function once for each field in the #GstStructure. In * contrast to gst_structure_foreach(), the function may modify but not delete the @@ -2229,8 +2229,8 @@ filter_and_map_in_place_quark_adapter (const GstIdStr * fieldname, /** * gst_structure_filter_and_map_in_place: * @structure: a #GstStructure - * @func: (scope call): a function to call for each field - * @user_data: (closure): private data + * @func: (scope call) (closure user_data): a function to call for each field + * @user_data: private data * * Calls the provided function once for each field in the #GstStructure. In * contrast to gst_structure_foreach(), the function may modify the fields. @@ -2255,8 +2255,8 @@ gst_structure_filter_and_map_in_place (GstStructure * structure, /** * gst_structure_foreach_id_str: * @structure: a #GstStructure - * @func: (scope call): a function to call for each field - * @user_data: (closure): private data + * @func: (scope call) (closure user_data): a function to call for each field + * @user_data: private data * * Calls the provided function once for each field in the #GstStructure. The * function must not modify the fields. Also see gst_structure_map_in_place_id_str() @@ -2294,8 +2294,8 @@ gst_structure_foreach_id_str (const GstStructure * structure, /** * gst_structure_map_in_place_id_str: * @structure: a #GstStructure - * @func: (scope call): a function to call for each field - * @user_data: (closure): private data + * @func: (scope call) (closure user_data): a function to call for each field + * @user_data: private data * * Calls the provided function once for each field in the #GstStructure. In * contrast to gst_structure_foreach_id_str(), the function may modify but not delete the @@ -2333,8 +2333,8 @@ gst_structure_map_in_place_id_str (GstStructure * structure, /** * gst_structure_filter_and_map_in_place_id_str: * @structure: a #GstStructure - * @func: (scope call): a function to call for each field - * @user_data: (closure): private data + * @func: (scope call) (closure user_data): a function to call for each field + * @user_data: private data * * Calls the provided function once for each field in the #GstStructure. In * contrast to gst_structure_foreach_id_str(), the function may modify the fields. diff --git a/subprojects/gstreamer/gst/gsttaglist.c b/subprojects/gstreamer/gst/gsttaglist.c index 34dd521c2a..44c26ee8a8 100644 --- a/subprojects/gstreamer/gst/gsttaglist.c +++ b/subprojects/gstreamer/gst/gsttaglist.c @@ -1413,8 +1413,8 @@ structure_foreach_wrapper (const GstIdStr * field, const GValue * value, /** * gst_tag_list_foreach: * @list: list to iterate over - * @func: (scope call): function to be called for each tag - * @user_data: (closure): user specified data + * @func: (scope call) (closure user_data): function to be called for each tag + * @user_data: user specified data * * Calls the given function for each tag inside the tag list. Note that if there * is no tag, the function won't be called at all. diff --git a/subprojects/gstreamer/gst/gsttaskpool.c b/subprojects/gstreamer/gst/gsttaskpool.c index 020a1d2db3..11f2a06e1f 100644 --- a/subprojects/gstreamer/gst/gsttaskpool.c +++ b/subprojects/gstreamer/gst/gsttaskpool.c @@ -233,8 +233,8 @@ gst_task_pool_cleanup (GstTaskPool * pool) /** * gst_task_pool_push: * @pool: a #GstTaskPool - * @func: (scope async): the function to call - * @user_data: (closure): data to pass to @func + * @func: (scope async) (closure user_data): the function to call + * @user_data: data to pass to @func * @error: return location for an error * * Start the execution of a new thread from @pool. diff --git a/subprojects/gstreamer/gst/gstutils.c b/subprojects/gstreamer/gst/gstutils.c index 401fdca9cd..03b2f6daea 100644 --- a/subprojects/gstreamer/gst/gstutils.c +++ b/subprojects/gstreamer/gst/gstutils.c @@ -3541,10 +3541,11 @@ 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: (scope call): function to compare two elements, @search_data will always be passed as second argument + * @search_func: (scope call) (closure user_data): 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 + * @user_data: data to pass to @search_func * * Searches inside @array for @search_data by using the comparison function * @search_func. @array must be sorted ascending. diff --git a/subprojects/gstreamer/libs/gst/base/gstcollectpads.c b/subprojects/gstreamer/libs/gst/base/gstcollectpads.c index abbae44956..fcc803ce92 100644 --- a/subprojects/gstreamer/libs/gst/base/gstcollectpads.c +++ b/subprojects/gstreamer/libs/gst/base/gstcollectpads.c @@ -304,8 +304,8 @@ gst_collect_pads_set_buffer_function_locked (GstCollectPads * pads, /** * gst_collect_pads_set_buffer_function: * @pads: the collectpads to use - * @func: (scope call): the function to set - * @user_data: (closure): user data passed to the function + * @func: (scope call) (closure user_data): the function to set + * @user_data: user data passed to the function * * Set the callback function and user data that will be called with * the oldest buffer when all pads have been collected, or %NULL on EOS. @@ -329,8 +329,8 @@ gst_collect_pads_set_buffer_function (GstCollectPads * pads, /** * gst_collect_pads_set_compare_function: * @pads: the pads to use - * @func: (scope call): the function to set - * @user_data: (closure): user data passed to the function + * @func: (scope call) (closure user_data): the function to set + * @user_data: user data passed to the function * * Set the timestamp comparison function. *