luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-04-16 04:28:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch '2227-gobject-annotation-fixes' into 'master'

Browse Source 
Add more GIR annotations to gparam.c and gsignal.c

See merge request GNOME/glib!1804
This commit is contained in:
Emmanuele Bassi 2021-01-19 11:35:15 +00:00
commit 8199fd65a9
2 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
gobject/gparam.c
View File

@ -439,7 +439,8 @@ g_param_spec_is_valid_name (const gchar *name)
* @blurb, which should be a somewhat longer description, suitable for * @blurb, which should be a somewhat longer description, suitable for
* e.g. a tooltip. The @nick and @blurb should ideally be localized. * e.g. a tooltip. The @nick and @blurb should ideally be localized.
* *
* Returns: (type GObject.ParamSpec): (transfer full): a newly allocated #GParamSpec instance * Returns: (type GObject.ParamSpec): (transfer floating): a newly allocated
* #GParamSpec instance, which is initially floating
*/ */
gpointer gpointer
g_param_spec_internal (GType param_type, g_param_spec_internal (GType param_type,

24
gobject/gsignal.c
View File

@ -1036,8 +1036,8 @@ signal_finalize_hook (GHookList *hook_list,
* @signal_id: the signal identifier, as returned by g_signal_lookup(). * @signal_id: the signal identifier, as returned by g_signal_lookup().
* @detail: the detail on which to call the hook. * @detail: the detail on which to call the hook.
* @hook_func: (not nullable): a #GSignalEmissionHook function. * @hook_func: (not nullable): a #GSignalEmissionHook function.
* @hook_data: (nullable): user data for @hook_func. * @hook_data: (nullable) (closure hook_func): user data for @hook_func.
* @data_destroy: (nullable): a #GDestroyNotify for @hook_data. * @data_destroy: (nullable) (destroy hook_data): a #GDestroyNotify for @hook_data.
* *
* Adds an emission hook for a signal, which will get called for any emission * Adds an emission hook for a signal, which will get called for any emission
* of that signal, independent of the instance. This is possible only * of that signal, independent of the instance. This is possible only
@ -1455,7 +1455,7 @@ g_signal_query (guint signal_id,
* for this type. Used to invoke a class method generically. Pass 0 to * for this type. Used to invoke a class method generically. Pass 0 to
* not associate a class method slot with this signal. * not associate a class method slot with this signal.
* @accumulator: (nullable): the accumulator for this signal; may be %NULL. * @accumulator: (nullable): the accumulator for this signal; may be %NULL.
* @accu_data: (nullable): user data for the @accumulator. * @accu_data: (nullable) (closure accumulator): user data for the @accumulator.
* @c_marshaller: (nullable): the function to translate arrays of parameter * @c_marshaller: (nullable): the function to translate arrays of parameter
* values to signal emissions into C language callback invocations or %NULL. * values to signal emissions into C language callback invocations or %NULL.
* @return_type: the type of return value, or #G_TYPE_NONE for a signal * @return_type: the type of return value, or #G_TYPE_NONE for a signal
@ -1531,7 +1531,7 @@ g_signal_new (const gchar *signal_name,
* this signal. Used to invoke a class method generically. Pass %NULL to * this signal. Used to invoke a class method generically. Pass %NULL to
* not associate a class method with this signal. * not associate a class method with this signal.
* @accumulator: (nullable): the accumulator for this signal; may be %NULL. * @accumulator: (nullable): the accumulator for this signal; may be %NULL.
* @accu_data: (nullable): user data for the @accumulator. * @accu_data: (nullable) (closure accumulator): user data for the @accumulator.
* @c_marshaller: (nullable): the function to translate arrays of parameter * @c_marshaller: (nullable): the function to translate arrays of parameter
* values to signal emissions into C language callback invocations or %NULL. * values to signal emissions into C language callback invocations or %NULL.
* @return_type: the type of return value, or #G_TYPE_NONE for a signal * @return_type: the type of return value, or #G_TYPE_NONE for a signal
@ -1668,7 +1668,7 @@ signal_add_class_closure (SignalNode *node,
* @class_closure: (nullable): The closure to invoke on signal emission; * @class_closure: (nullable): The closure to invoke on signal emission;
* may be %NULL * may be %NULL
* @accumulator: (nullable): the accumulator for this signal; may be %NULL * @accumulator: (nullable): the accumulator for this signal; may be %NULL
* @accu_data: (nullable): user data for the @accumulator * @accu_data: (nullable) (closure accumulator): user data for the @accumulator
* @c_marshaller: (nullable): the function to translate arrays of * @c_marshaller: (nullable): the function to translate arrays of
* parameter values to signal emissions into C language callback * parameter values to signal emissions into C language callback
* invocations or %NULL * invocations or %NULL
@ -1929,7 +1929,7 @@ g_signal_set_va_marshaller (guint signal_id,
* %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST. * %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
* @class_closure: (nullable): The closure to invoke on signal emission; may be %NULL. * @class_closure: (nullable): The closure to invoke on signal emission; may be %NULL.
* @accumulator: (nullable): the accumulator for this signal; may be %NULL. * @accumulator: (nullable): the accumulator for this signal; may be %NULL.
* @accu_data: (nullable): user data for the @accumulator. * @accu_data: (nullable) (closure accumulator): user data for the @accumulator.
* @c_marshaller: (nullable): the function to translate arrays of parameter * @c_marshaller: (nullable): the function to translate arrays of parameter
* values to signal emissions into C language callback invocations or %NULL. * values to signal emissions into C language callback invocations or %NULL.
* @return_type: the type of return value, or #G_TYPE_NONE for a signal * @return_type: the type of return value, or #G_TYPE_NONE for a signal
@ -2534,8 +2534,8 @@ node_check_deprecated (const SignalNode *node)
* @instance: (type GObject.Object): the instance to connect to. * @instance: (type GObject.Object): the instance to connect to.
* @detailed_signal: a string of the form "signal-name::detail". * @detailed_signal: a string of the form "signal-name::detail".
* @c_handler: (not nullable): the #GCallback to connect. * @c_handler: (not nullable): the #GCallback to connect.
* @data: (nullable): data to pass to @c_handler calls. * @data: (nullable) (closure c_handler): data to pass to @c_handler calls.
* @destroy_data: (nullable): a #GClosureNotify for @data. * @destroy_data: (nullable) (destroy data): a #GClosureNotify for @data.
* @connect_flags: a combination of #GConnectFlags. * @connect_flags: a combination of #GConnectFlags.
* *
* Connects a #GCallback function to a signal for a particular object. Similar * Connects a #GCallback function to a signal for a particular object. Similar
@ -2812,7 +2812,7 @@ g_signal_handlers_destroy (gpointer instance)
* @detail: Signal detail the handler has to be connected to. * @detail: Signal detail the handler has to be connected to.
* @closure: (nullable): The closure the handler will invoke. * @closure: (nullable): The closure the handler will invoke.
* @func: The C closure callback of the handler (useless for non-C closures). * @func: The C closure callback of the handler (useless for non-C closures).
* @data: (nullable): The closure data of the handler's closure. * @data: (nullable) (closure closure): The closure data of the handler's closure.
* *
* Finds the first signal handler that matches certain selection criteria. * Finds the first signal handler that matches certain selection criteria.
* The criteria mask is passed as an OR-ed combination of #GSignalMatchType * The criteria mask is passed as an OR-ed combination of #GSignalMatchType
@ -2892,7 +2892,7 @@ signal_handlers_foreach_matched_R (gpointer instance,
* @detail: Signal detail the handlers have to be connected to. * @detail: Signal detail the handlers have to be connected to.
* @closure: (nullable): The closure the handlers will invoke. * @closure: (nullable): The closure the handlers will invoke.
* @func: The C closure callback of the handlers (useless for non-C closures). * @func: The C closure callback of the handlers (useless for non-C closures).
* @data: (nullable): The closure data of the handlers' closures. * @data: (nullable) (closure closure): The closure data of the handlers' closures.
* *
* Blocks all handlers on an instance that match a certain selection criteria. * Blocks all handlers on an instance that match a certain selection criteria.
* The criteria mask is passed as an OR-ed combination of #GSignalMatchType * The criteria mask is passed as an OR-ed combination of #GSignalMatchType
@ -2939,7 +2939,7 @@ g_signal_handlers_block_matched (gpointer instance,
* @detail: Signal detail the handlers have to be connected to. * @detail: Signal detail the handlers have to be connected to.
* @closure: (nullable): The closure the handlers will invoke. * @closure: (nullable): The closure the handlers will invoke.
* @func: The C closure callback of the handlers (useless for non-C closures). * @func: The C closure callback of the handlers (useless for non-C closures).
* @data: (nullable): The closure data of the handlers' closures. * @data: (nullable) (closure closure): The closure data of the handlers' closures.
* *
* Unblocks all handlers on an instance that match a certain selection * Unblocks all handlers on an instance that match a certain selection
* criteria. The criteria mask is passed as an OR-ed combination of * criteria. The criteria mask is passed as an OR-ed combination of
@ -2987,7 +2987,7 @@ g_signal_handlers_unblock_matched (gpointer instance,
* @detail: Signal detail the handlers have to be connected to. * @detail: Signal detail the handlers have to be connected to.
* @closure: (nullable): The closure the handlers will invoke. * @closure: (nullable): The closure the handlers will invoke.
* @func: The C closure callback of the handlers (useless for non-C closures). * @func: The C closure callback of the handlers (useless for non-C closures).
* @data: (nullable): The closure data of the handlers' closures. * @data: (nullable) (closure closure): The closure data of the handlers' closures.
* *
* Disconnects all handlers on an instance that match a certain * Disconnects all handlers on an instance that match a certain
* selection criteria. The criteria mask is passed as an OR-ed * selection criteria. The criteria mask is passed as an OR-ed