luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-11-11 03:46:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch '2227-more-nullables-more' into 'master'

Browse Source 
gobject: More missing return value annotations

See merge request GNOME/glib!1802
This commit is contained in:
Emmanuele Bassi 2020-12-12 00:04:31 +00:00
commit adaca14133
3 changed files with 50 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
gobject/genums.c
View File

@ -392,7 +392,7 @@ g_flags_class_init (GFlagsClass *class,
*
* Looks up a #GEnumValue by name.
*
* Returns: (transfer none): the #GEnumValue with name @name,
* Returns: (transfer none) (nullable): the #GEnumValue with name @name,
* or %NULL if the enumeration doesn't have a member
* with that name
*/
@ -422,7 +422,7 @@ g_enum_get_value_by_name (GEnumClass *enum_class,
*
* Looks up a #GFlagsValue by name.
*
* Returns: (transfer none): the #GFlagsValue with name @name,
* Returns: (transfer none) (nullable): the #GFlagsValue with name @name,
* or %NULL if there is no flag with that name
*/
GFlagsValue*
@ -451,7 +451,7 @@ g_flags_get_value_by_name (GFlagsClass *flags_class,
*
* Looks up a #GEnumValue by nickname.
*
* Returns: (transfer none): the #GEnumValue with nickname @nick,
* Returns: (transfer none) (nullable): the #GEnumValue with nickname @nick,
* or %NULL if the enumeration doesn't have a member
* with that nickname
*/
@ -481,7 +481,7 @@ g_enum_get_value_by_nick (GEnumClass *enum_class,
*
* Looks up a #GFlagsValue by nickname.
*
* Returns: (transfer none): the #GFlagsValue with nickname @nick,
* Returns: (transfer none) (nullable): the #GFlagsValue with nickname @nick,
* or %NULL if there is no flag with that nickname
*/
GFlagsValue*
@ -510,7 +510,7 @@ g_flags_get_value_by_nick (GFlagsClass *flags_class,
*
* Returns the #GEnumValue for a value.
*
* Returns: (transfer none): the #GEnumValue for @value, or %NULL
* Returns: (transfer none) (nullable): the #GEnumValue for @value, or %NULL
* if @value is not a member of the enumeration
*/
GEnumValue*
@ -538,7 +538,7 @@ g_enum_get_value (GEnumClass *enum_class,
*
* Returns the first #GFlagsValue which is set in @value.
*
* Returns: (transfer none): the first #GFlagsValue which is set in
* Returns: (transfer none) (nullable): the first #GFlagsValue which is set in
* @value, or %NULL if none is set
*/
GFlagsValue*

34
gobject/gparam.c
View File

@ -203,11 +203,11 @@ g_param_spec_finalize (GParamSpec *pspec)
/**
* g_param_spec_ref: (skip)
* @pspec: a valid #GParamSpec
* @pspec: (transfer none) (not nullable): a valid #GParamSpec
*
* Increments the reference count of @pspec.
*
* Returns: the #GParamSpec that was passed into this function
* Returns: (transfer full) (not nullable): the #GParamSpec that was passed into this function
*/
GParamSpec*
g_param_spec_ref (GParamSpec *pspec)
@ -270,7 +270,7 @@ g_param_spec_sink (GParamSpec *pspec)
* Convenience function to ref and sink a #GParamSpec.
*
* Since: 2.10
* Returns: the #GParamSpec that was passed into this function
* Returns: (transfer full) (not nullable): the #GParamSpec that was passed into this function
*/
GParamSpec*
g_param_spec_ref_sink (GParamSpec *pspec)
@ -337,7 +337,7 @@ g_param_spec_get_nick (GParamSpec *pspec)
*
* Get the short description of a #GParamSpec.
*
* Returns: the short description of @pspec.
* Returns: (nullable): the short description of @pspec.
*/
const gchar *
g_param_spec_get_blurb (GParamSpec *pspec)
@ -439,7 +439,7 @@ g_param_spec_is_valid_name (const gchar *name)
* @blurb, which should be a somewhat longer description, suitable for
* e.g. a tooltip. The @nick and @blurb should ideally be localized.
*
* Returns: (type GObject.ParamSpec): a newly allocated #GParamSpec instance
* Returns: (type GObject.ParamSpec): (transfer full): a newly allocated #GParamSpec instance
*/
gpointer
g_param_spec_internal (GType param_type,
@ -503,7 +503,7 @@ g_param_spec_internal (GType param_type,
*
* Gets back user data pointers stored via g_param_spec_set_qdata().
*
* Returns: (transfer none): the user data pointer set, or %NULL
* Returns: (transfer none) (nullable): the user data pointer set, or %NULL
*/
gpointer
g_param_spec_get_qdata (GParamSpec *pspec,
@ -518,7 +518,7 @@ g_param_spec_get_qdata (GParamSpec *pspec,
* g_param_spec_set_qdata:
* @pspec: the #GParamSpec to set store a user data pointer
* @quark: a #GQuark, naming the user data pointer
* @data: an opaque user data pointer
* @data: (nullable): an opaque user data pointer
*
* Sets an opaque, named pointer on a #GParamSpec. The name is
* specified through a #GQuark (retrieved e.g. via
@ -542,8 +542,8 @@ g_param_spec_set_qdata (GParamSpec *pspec,
* g_param_spec_set_qdata_full: (skip)
* @pspec: the #GParamSpec to set store a user data pointer
* @quark: a #GQuark, naming the user data pointer
* @data: an opaque user data pointer
* @destroy: function to invoke with @data as argument, when @data needs to
* @data: (nullable): an opaque user data pointer
* @destroy: (nullable): function to invoke with @data as argument, when @data needs to
* be freed
*
* This function works like g_param_spec_set_qdata(), but in addition,
@ -574,7 +574,7 @@ g_param_spec_set_qdata_full (GParamSpec *pspec,
* function (if any was set). Usually, calling this function is only
* required to update user data pointers with a destroy notifier.
*
* Returns: (transfer none): the user data pointer set, or %NULL
* Returns: (transfer none) (nullable): the user data pointer set, or %NULL
*/
gpointer
g_param_spec_steal_qdata (GParamSpec *pspec,
@ -600,7 +600,7 @@ g_param_spec_steal_qdata (GParamSpec *pspec,
*
* Since: 2.4
*
* Returns: (transfer none): paramspec to which requests on this
* Returns: (transfer none) (nullable): paramspec to which requests on this
* paramspec should be redirected, or %NULL if none.
*/
GParamSpec*
@ -935,7 +935,7 @@ param_spec_pool_equals (gconstpointer key_spec_1,
* property name, like "GtkContainer:border-width". This feature is
* deprecated, so you should always set @type_prefixing to %FALSE.
*
* Returns: (transfer none): a newly allocated #GParamSpecPool.
* Returns: (transfer full): a newly allocated #GParamSpecPool.
*/
GParamSpecPool*
g_param_spec_pool_new (gboolean type_prefixing)
@ -953,7 +953,7 @@ g_param_spec_pool_new (gboolean type_prefixing)
/**
* g_param_spec_pool_insert:
* @pool: a #GParamSpecPool.
* @pspec: the #GParamSpec to insert
* @pspec: (transfer none) (not nullable): the #GParamSpec to insert
* @owner_type: a #GType identifying the owner of @pspec
*
* Inserts a #GParamSpec in the pool.
@ -993,7 +993,7 @@ g_param_spec_pool_insert (GParamSpecPool *pool,
/**
* g_param_spec_pool_remove:
* @pool: a #GParamSpecPool
* @pspec: the #GParamSpec to remove
* @pspec: (transfer none) (not nullable): the #GParamSpec to remove
*
* Removes a #GParamSpec from the pool.
*/
@ -1081,7 +1081,7 @@ param_spec_ht_lookup (GHashTable *hash_table,
*
* Looks up a #GParamSpec in the pool.
*
* Returns: (transfer none): The found #GParamSpec, or %NULL if no
* Returns: (transfer none) (nullable): The found #GParamSpec, or %NULL if no
* matching #GParamSpec was found.
*/
GParamSpec*
@ -1542,8 +1542,8 @@ g_value_get_param (const GValue *value)
* Get the contents of a %G_TYPE_PARAM #GValue, increasing its
* reference count.
*
* Returns: #GParamSpec content of @value, should be unreferenced when
* no longer needed.
* Returns: (transfer full): #GParamSpec content of @value, should be
* unreferenced when no longer needed.
*/
GParamSpec*
g_value_dup_param (const GValue *value)

53
gobject/gsignal.c
View File

@ -1035,9 +1035,9 @@ signal_finalize_hook (GHookList *hook_list,
* g_signal_add_emission_hook:
* @signal_id: the signal identifier, as returned by g_signal_lookup().
* @detail: the detail on which to call the hook.
* @hook_func: a #GSignalEmissionHook function.
* @hook_data: user data for @hook_func.
* @data_destroy: a #GDestroyNotify for @hook_data.
* @hook_func: (not nullable): a #GSignalEmissionHook function.
* @hook_data: (nullable): user data for @hook_func.
* @data_destroy: (nullable): a #GDestroyNotify for @hook_data.
*
* 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
@ -1389,7 +1389,7 @@ g_signal_list_ids (GType itype,
*
* Two different signals may have the same name, if they have differing types.
*
* Returns: the signal name, or %NULL if the signal number was invalid.
* Returns: (nullable): the signal name, or %NULL if the signal number was invalid.
*/
const gchar *
g_signal_name (guint signal_id)
@ -1408,7 +1408,7 @@ g_signal_name (guint signal_id)
/**
* g_signal_query:
* @signal_id: The signal id of the signal to query information for.
* @query: (out caller-allocates): A user provided structure that is
* @query: (out caller-allocates) (not optional): A user provided structure that is
* filled in with constant values upon success.
*
* Queries the signal system for in-depth information about a
@ -1454,8 +1454,8 @@ g_signal_query (guint signal_id,
* @class_offset: The offset of the function pointer in the class structure
* for this type. Used to invoke a class method generically. Pass 0 to
* not associate a class method slot with this signal.
* @accumulator: the accumulator for this signal; may be %NULL.
* @accu_data: user data for the @accumulator.
* @accumulator: (nullable): the accumulator for this signal; may be %NULL.
* @accu_data: (nullable): user data for the @accumulator.
* @c_marshaller: (nullable): the function to translate arrays of parameter
* 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
@ -1527,11 +1527,11 @@ g_signal_new (const gchar *signal_name,
* @signal_flags: a combination of #GSignalFlags specifying detail of when
* the default handler is to be invoked. You should at least specify
* %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
* @class_handler: a #GCallback which acts as class implementation of
* @class_handler: (nullable): a #GCallback which acts as class implementation of
* this signal. Used to invoke a class method generically. Pass %NULL to
* not associate a class method with this signal.
* @accumulator: the accumulator for this signal; may be %NULL.
* @accu_data: user data for the @accumulator.
* @accumulator: (nullable): the accumulator for this signal; may be %NULL.
* @accu_data: (nullable): user data for the @accumulator.
* @c_marshaller: (nullable): the function to translate arrays of parameter
* 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
@ -1668,15 +1668,15 @@ signal_add_class_closure (SignalNode *node,
* @class_closure: (nullable): The closure to invoke on signal emission;
* may be %NULL
* @accumulator: (nullable): the accumulator for this signal; may be %NULL
* @accu_data: user data for the @accumulator
* @accu_data: (nullable): user data for the @accumulator
* @c_marshaller: (nullable): the function to translate arrays of
* parameter 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
* without a return value
* @n_params: the length of @param_types
* @param_types: (array length=n_params): an array of types, one for
* each parameter
* @param_types: (array length=n_params) (nullable): an array of types, one for
* each parameter (may be %NULL if @n_params is zero)
*
* Creates a new signal. (This is usually done in the class initializer.)
*
@ -1935,9 +1935,9 @@ g_signal_set_va_marshaller (guint signal_id,
* @signal_flags: a combination of #GSignalFlags specifying detail of when
* the default handler is to be invoked. You should at least specify
* %G_SIGNAL_RUN_FIRST or %G_SIGNAL_RUN_LAST.
* @class_closure: The closure to invoke on signal emission; may be %NULL.
* @accumulator: the accumulator for this signal; may be %NULL.
* @accu_data: user data for the @accumulator.
* @class_closure: (nullable): The closure to invoke on signal emission; may be %NULL.
* @accumulator: (nullable): the accumulator for this signal; may be %NULL.
* @accu_data: (nullable): user data for the @accumulator.
* @c_marshaller: (nullable): the function to translate arrays of parameter
* 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
@ -2366,7 +2366,8 @@ g_signal_chain_from_overridden_handler (gpointer instance,
*
* Returns the invocation hint of the innermost signal emission of instance.
*
* Returns: (transfer none): the invocation hint of the innermost signal emission.
* Returns: (transfer none) (nullable): the invocation hint of the innermost
* signal emission, or %NULL if not found.
*/
GSignalInvocationHint*
g_signal_get_invocation_hint (gpointer instance)
@ -2387,7 +2388,7 @@ g_signal_get_invocation_hint (gpointer instance)
* @instance: (type GObject.Object): the instance to connect to.
* @signal_id: the id of the signal.
* @detail: the detail.
* @closure: the closure to connect.
* @closure: (not nullable): the closure to connect.
* @after: whether the handler should be called before or after the
* default handler of the signal.
*
@ -2449,7 +2450,7 @@ g_signal_connect_closure_by_id (gpointer instance,
* g_signal_connect_closure:
* @instance: (type GObject.Object): the instance to connect to.
* @detailed_signal: a string of the form "signal-name::detail".
* @closure: the closure to connect.
* @closure: (not nullable): the closure to connect.
* @after: whether the handler should be called before or after the
* default handler of the signal.
*
@ -2540,9 +2541,9 @@ node_check_deprecated (const SignalNode *node)
* g_signal_connect_data:
* @instance: (type GObject.Object): the instance to connect to.
* @detailed_signal: a string of the form "signal-name::detail".
* @c_handler: the #GCallback to connect.
* @data: data to pass to @c_handler calls.
* @destroy_data: a #GClosureNotify for @data.
* @c_handler: (not nullable): the #GCallback to connect.
* @data: (nullable): data to pass to @c_handler calls.
* @destroy_data: (nullable): a #GClosureNotify for @data.
* @connect_flags: a combination of #GConnectFlags.
*
* Connects a #GCallback function to a signal for a particular object. Similar
@ -2819,7 +2820,7 @@ g_signal_handlers_destroy (gpointer instance)
* @detail: Signal detail the handler has to be connected to.
* @closure: (nullable): The closure the handler will invoke.
* @func: The C closure callback of the handler (useless for non-C closures).
* @data: The closure data of the handler's closure.
* @data: (nullable): The closure data of the handler's closure.
*
* Finds the first signal handler that matches certain selection criteria.
* The criteria mask is passed as an OR-ed combination of #GSignalMatchType
@ -2899,7 +2900,7 @@ signal_handlers_foreach_matched_R (gpointer instance,
* @detail: Signal detail the handlers have to be connected to.
* @closure: (nullable): The closure the handlers will invoke.
* @func: The C closure callback of the handlers (useless for non-C closures).
* @data: The closure data of the handlers' closures.
* @data: (nullable): The closure data of the handlers' closures.
*
* Blocks all handlers on an instance that match a certain selection criteria.
* The criteria mask is passed as an OR-ed combination of #GSignalMatchType
@ -2946,7 +2947,7 @@ g_signal_handlers_block_matched (gpointer instance,
* @detail: Signal detail the handlers have to be connected to.
* @closure: (nullable): The closure the handlers will invoke.
* @func: The C closure callback of the handlers (useless for non-C closures).
* @data: The closure data of the handlers' closures.
* @data: (nullable): The closure data of the handlers' closures.
*
* Unblocks all handlers on an instance that match a certain selection
* criteria. The criteria mask is passed as an OR-ed combination of
@ -2994,7 +2995,7 @@ g_signal_handlers_unblock_matched (gpointer instance,
* @detail: Signal detail the handlers have to be connected to.
* @closure: (nullable): The closure the handlers will invoke.
* @func: The C closure callback of the handlers (useless for non-C closures).
* @data: The closure data of the handlers' closures.
* @data: (nullable): The closure data of the handlers' closures.
*
* Disconnects all handlers on an instance that match a certain
* selection criteria. The criteria mask is passed as an OR-ed