diff options
author | Emmanuele Bassi <ebassi@gnome.org> | 2022-09-21 13:24:08 +0100 |
---|---|---|
committer | Emmanuele Bassi <ebassi@gnome.org> | 2022-09-21 13:24:08 +0100 |
commit | 1122952c381424351c0350f7acf0af419d653440 (patch) | |
tree | 5f5bef83603e8fded9b4c16790443554fb40070a | |
parent | 7aa3614c488f5ae926e78fdcf7938c86744a8741 (diff) | |
download | gobject-introspection-1122952c381424351c0350f7acf0af419d653440.tar.gz |
Update GLib introspection data
Reset against GLib 2.72.4; some symbols introduced in GLib 2.74 have
managed to sneak in. Luckily, there has been no release off of this
branch, yet.
-rw-r--r-- | gir/gio-2.0.c | 31 | ||||
-rw-r--r-- | gir/glib-2.0.c | 58 | ||||
-rw-r--r-- | gir/gobject-2.0.c | 121 |
3 files changed, 97 insertions, 113 deletions
diff --git a/gir/gio-2.0.c b/gir/gio-2.0.c index d0adef41..8d875c04 100644 --- a/gir/gio-2.0.c +++ b/gir/gio-2.0.c @@ -3381,7 +3381,7 @@ /** - * GSimpleProxyResolver:default-proxy: + * GSimpleProxyResolver:default-proxy: (nullable) * * The default proxy URI that will be used for any URI that doesn't * match #GSimpleProxyResolver:ignore-hosts, and doesn't match any @@ -11379,8 +11379,8 @@ * @action_group: a #GActionGroup * @action_name: the name of an action in the group * @enabled: (out): if the action is presently enabled - * @parameter_type: (out) (optional): the parameter type, or %NULL if none needed - * @state_type: (out) (optional): the state type, or %NULL if stateless + * @parameter_type: (out) (transfer none) (optional): the parameter type, or %NULL if none needed + * @state_type: (out) (transfer none) (optional): the state type, or %NULL if stateless * @state_hint: (out) (optional): the state hint, or %NULL if none * @state: (out) (optional): the current state, or %NULL if stateless * @@ -28398,7 +28398,7 @@ * @position: (out) (optional): the first position of @item, if it was found. * * Looks up the given @item in the list store by looping over the items and - * comparing them with @equal_func until the first occurrence of @item which + * comparing them with @compare_func until the first occurrence of @item which * matches. If @item was not found, then @position will not be set, and this * method will return %FALSE. * @@ -28409,23 +28409,6 @@ /** - * g_list_store_find_with_equal_func_full: - * @store: a #GListStore - * @item: (type GObject): an item - * @equal_func: (scope call): A custom equality check function - * @user_data: (closure): user data for @equal_func - * @position: (out) (optional): the first position of @item, if it was found. - * - * Like g_list_store_find_with_equal_func() but with an additional @user_data - * that is passed to @equal_func. - * - * Returns: Whether @store contains @item. If it was found, @position will be - * set to the position where @item occurred for the first time. - * Since: 2.74 - */ - - -/** * g_list_store_insert: * @store: a #GListStore * @position: the position at which to insert the new item @@ -35560,7 +35543,7 @@ /** * g_simple_proxy_resolver_set_default_proxy: * @resolver: a #GSimpleProxyResolver - * @default_proxy: the default proxy to use + * @default_proxy: (nullable): the default proxy to use * * Sets the default proxy on @resolver, to be used for any URIs that * don't match #GSimpleProxyResolver:ignore-hosts or a proxy set @@ -35651,7 +35634,7 @@ * internal errors (other than @cancellable being triggered) will be * ignored. * - * Returns: (transfer full): a #GSocketAddress (owned by the caller), or %NULL on + * Returns: (transfer full) (nullable): a #GSocketAddress (owned by the caller), or %NULL on * error (in which case *@error will be set) or if there are no * more addresses. */ @@ -35684,7 +35667,7 @@ * g_socket_address_enumerator_next() for more information about * error handling. * - * Returns: (transfer full): a #GSocketAddress (owned by the caller), or %NULL on + * Returns: (transfer full) (nullable): a #GSocketAddress (owned by the caller), or %NULL on * error (in which case *@error will be set) or if there are no * more addresses. */ diff --git a/gir/glib-2.0.c b/gir/glib-2.0.c index ba9e2b8f..8a8a35c2 100644 --- a/gir/glib-2.0.c +++ b/gir/glib-2.0.c @@ -539,12 +539,6 @@ * Network and storage sizes should be reported in the normal SI units. * @G_FORMAT_SIZE_BITS: set the size as a quantity in bits, rather than * bytes, and return units in bits. For example, ‘Mb’ rather than ‘MB’. - * @G_FORMAT_SIZE_ONLY_VALUE: return only value, without unit; this should - * not be used together with @G_FORMAT_SIZE_LONG_FORMAT - * nor @G_FORMAT_SIZE_ONLY_UNIT. Since: 2.74 - * @G_FORMAT_SIZE_ONLY_UNIT: return only unit, without value; this should - * not be used together with @G_FORMAT_SIZE_LONG_FORMAT - * nor @G_FORMAT_SIZE_ONLY_VALUE. Since: 2.74 * * Flags to modify the format of the string returned by g_format_size_full(). */ @@ -9229,6 +9223,9 @@ * alignment value. Additionally, it will detect possible overflow during * multiplication. * + * If the allocation fails (because the system is out of memory), + * the program is terminated. + * * Aligned memory allocations returned by this function can only be * freed using g_aligned_free(). * @@ -19348,9 +19345,9 @@ * g_iconv: (skip) * @converter: conversion descriptor from g_iconv_open() * @inbuf: bytes to convert - * @inbytes_left: (inout): inout parameter, bytes remaining to convert in @inbuf + * @inbytes_left: inout parameter, bytes remaining to convert in @inbuf * @outbuf: converted output bytes - * @outbytes_left: (inout): inout parameter, bytes available to fill in @outbuf + * @outbytes_left: inout parameter, bytes available to fill in @outbuf * * Same as the standard UNIX routine iconv(), but * may be implemented via libiconv on UNIX flavors that lack @@ -23168,6 +23165,9 @@ * Allocates @n_bytes bytes of memory. * If @n_bytes is 0 it returns %NULL. * + * If the allocation fails (because the system is out of memory), + * the program is terminated. + * * Returns: a pointer to the allocated memory */ @@ -23179,6 +23179,9 @@ * Allocates @n_bytes bytes of memory, initialized to 0's. * If @n_bytes is 0 it returns %NULL. * + * If the allocation fails (because the system is out of memory), + * the program is terminated. + * * Returns: a pointer to the allocated memory */ @@ -23191,6 +23194,9 @@ * This function is similar to g_malloc0(), allocating (@n_blocks * @n_block_bytes) bytes, * but care is taken to detect possible overflow during multiplication. * + * If the allocation fails (because the system is out of memory), + * the program is terminated. + * * Since: 2.24 * Returns: a pointer to the allocated memory */ @@ -23204,6 +23210,9 @@ * This function is similar to g_malloc(), allocating (@n_blocks * @n_block_bytes) bytes, * but care is taken to detect possible overflow during multiplication. * + * If the allocation fails (because the system is out of memory), + * the program is terminated. + * * Since: 2.24 * Returns: a pointer to the allocated memory */ @@ -24328,7 +24337,7 @@ * Calling g_mutex_clear() on a locked mutex leads to undefined * behaviour. * - * Sine: 2.32 + * Since: 2.32 */ @@ -26181,7 +26190,7 @@ * g_ptr_array_unref(), when g_ptr_array_free() is called with * @free_segment set to %TRUE or when removing elements. * - * Returns: A new #GPtrArray + * Returns: (transfer full): A new #GPtrArray * Since: 2.30 */ @@ -26196,7 +26205,7 @@ * either via g_ptr_array_unref(), when g_ptr_array_free() is called with * @free_segment set to %TRUE or when removing elements. * - * Returns: A new #GPtrArray + * Returns: (transfer full): A new #GPtrArray * Since: 2.22 */ @@ -26488,8 +26497,9 @@ * g_assert (chunk_buffer->len == 0); * ]| * - * Returns: (transfer full): the element data, which should be - * freed using g_free(). + * Returns: (transfer full) (nullable): the element data, which should be + * freed using g_free(). This may be %NULL if the array doesn’t have any + * elements (i.e. if `*len` is zero). * Since: 2.64 */ @@ -27511,6 +27521,9 @@ * have zero-length. @n_bytes may be 0, in which case %NULL will be returned * and @mem will be freed unless it is %NULL. * + * If the allocation fails (because the system is out of memory), + * the program is terminated. + * * Returns: the new address of the allocated memory */ @@ -27524,6 +27537,9 @@ * This function is similar to g_realloc(), allocating (@n_blocks * @n_block_bytes) bytes, * but care is taken to detect possible overflow during multiplication. * + * If the allocation fails (because the system is out of memory), + * the program is terminated. + * * Since: 2.24 * Returns: the new address of the allocated memory */ @@ -27542,7 +27558,7 @@ * Calling g_rec_mutex_clear() on a locked recursive mutex leads * to undefined behaviour. * - * Sine: 2.32 + * Since: 2.32 */ @@ -28511,7 +28527,7 @@ * Calling g_rw_lock_clear() when any thread holds the lock * leads to undefined behaviour. * - * Sine: 2.32 + * Since: 2.32 */ @@ -37134,7 +37150,7 @@ /** * g_unix_open_pipe: - * @fds: Array of two integers + * @fds: (array fixed-size=2): Array of two integers * @flags: Bitfield of file descriptor flags, as for fcntl() * @error: a #GError * @@ -37215,11 +37231,11 @@ * * For example, an effective use of this function is to handle `SIGTERM` * cleanly; flushing any outstanding files, and then calling - * g_main_loop_quit (). It is not safe to do any of this a regular - * UNIX signal handler; your handler may be invoked while malloc() or - * another library function is running, causing reentrancy if you - * attempt to use it from the handler. None of the GLib/GObject API - * is safe against this kind of reentrancy. + * g_main_loop_quit(). It is not safe to do any of this from a regular + * UNIX signal handler; such a handler may be invoked while malloc() or + * another library function is running, causing reentrancy issues if the + * handler attempts to use those functions. None of the GLib/GObject + * API is safe against this kind of reentrancy. * * The interaction of this source when combined with native UNIX * functions like sigprocmask() is not defined. diff --git a/gir/gobject-2.0.c b/gir/gobject-2.0.c index cfbf3473..2628eaf8 100644 --- a/gir/gobject-2.0.c +++ b/gir/gobject-2.0.c @@ -3925,8 +3925,8 @@ /** * g_param_spec_boolean: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @default_value: default value for the property specified * @flags: flags for the property specified * @@ -3945,8 +3945,8 @@ /** * g_param_spec_boxed: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @boxed_type: %G_TYPE_BOXED derived type of this property * @flags: flags for the property specified * @@ -3962,8 +3962,8 @@ /** * g_param_spec_char: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @minimum: minimum value for the property specified * @maximum: maximum value for the property specified * @default_value: default value for the property specified @@ -3978,8 +3978,8 @@ /** * g_param_spec_double: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @minimum: minimum value for the property specified * @maximum: maximum value for the property specified * @default_value: default value for the property specified @@ -3997,8 +3997,8 @@ /** * g_param_spec_enum: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @enum_type: a #GType derived from %G_TYPE_ENUM * @default_value: default value for the property specified * @flags: flags for the property specified @@ -4015,8 +4015,8 @@ /** * g_param_spec_flags: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @flags_type: a #GType derived from %G_TYPE_FLAGS * @default_value: default value for the property specified * @flags: flags for the property specified @@ -4033,8 +4033,8 @@ /** * g_param_spec_float: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @minimum: minimum value for the property specified * @maximum: maximum value for the property specified * @default_value: default value for the property specified @@ -4137,8 +4137,8 @@ /** * g_param_spec_gtype: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @is_a_type: a #GType whose subtypes are allowed as values * of the property (use %G_TYPE_NONE for any type) * @flags: flags for the property specified @@ -4156,8 +4156,8 @@ /** * g_param_spec_int: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @minimum: minimum value for the property specified * @maximum: maximum value for the property specified * @default_value: default value for the property specified @@ -4174,8 +4174,8 @@ /** * g_param_spec_int64: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @minimum: minimum value for the property specified * @maximum: maximum value for the property specified * @default_value: default value for the property specified @@ -4193,8 +4193,8 @@ * g_param_spec_internal: (skip) * @param_type: the #GType for the property; must be derived from %G_TYPE_PARAM * @name: the canonical name of the property - * @nick: the nickname of the property - * @blurb: a short description of the property + * @nick: (nullable): the nickname of the property + * @blurb: (nullable): a short description of the property * @flags: a combination of #GParamFlags * * Creates a new #GParamSpec instance. @@ -4203,11 +4203,12 @@ * the rules for @name. Names which violate these rules lead to undefined * behaviour. * - * Beyond the name, #GParamSpecs have two more descriptive - * strings associated with them, the @nick, which should be suitable - * for use as a label for the property in a property editor, and the - * @blurb, which should be a somewhat longer description, suitable for - * e.g. a tooltip. The @nick and @blurb should ideally be localized. + * Beyond the name, #GParamSpecs have two more descriptive strings, the + * @nick and @blurb, which may be used as a localized label and description. + * For GTK and related libraries these are considered deprecated and may be + * omitted, while for other libraries such as GStreamer and its plugins they + * are essential. When in doubt, follow the conventions used in the + * surrounding code and supporting libraries. * * Returns: (type GObject.ParamSpec): (transfer floating): a newly allocated * #GParamSpec instance, which is initially floating @@ -4233,8 +4234,8 @@ /** * g_param_spec_long: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @minimum: minimum value for the property specified * @maximum: maximum value for the property specified * @default_value: default value for the property specified @@ -4251,8 +4252,8 @@ /** * g_param_spec_object: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @object_type: %G_TYPE_OBJECT derived type of this property * @flags: flags for the property specified * @@ -4282,8 +4283,8 @@ /** * g_param_spec_param: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @param_type: a #GType derived from %G_TYPE_PARAM * @flags: flags for the property specified * @@ -4299,8 +4300,8 @@ /** * g_param_spec_pointer: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @flags: flags for the property specified * * Creates a new #GParamSpecPointer instance specifying a pointer property. @@ -4474,8 +4475,8 @@ /** * g_param_spec_string: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @default_value: (nullable): default value for the property specified * @flags: flags for the property specified * @@ -4490,8 +4491,8 @@ /** * g_param_spec_uchar: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @minimum: minimum value for the property specified * @maximum: maximum value for the property specified * @default_value: default value for the property specified @@ -4506,8 +4507,8 @@ /** * g_param_spec_uint: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @minimum: minimum value for the property specified * @maximum: maximum value for the property specified * @default_value: default value for the property specified @@ -4524,8 +4525,8 @@ /** * g_param_spec_uint64: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @minimum: minimum value for the property specified * @maximum: maximum value for the property specified * @default_value: default value for the property specified @@ -4543,8 +4544,8 @@ /** * g_param_spec_ulong: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @minimum: minimum value for the property specified * @maximum: maximum value for the property specified * @default_value: default value for the property specified @@ -4562,8 +4563,8 @@ /** * g_param_spec_unichar: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @default_value: default value for the property specified * @flags: flags for the property specified * @@ -4588,8 +4589,8 @@ /** * g_param_spec_value_array: (skip) * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @element_spec: a #GParamSpec describing the elements contained in * arrays of this property, may be %NULL * @flags: flags for the property specified @@ -4608,8 +4609,8 @@ /** * g_param_spec_variant: * @name: canonical name of the property specified - * @nick: nick name for the property specified - * @blurb: description of the property specified + * @nick: (nullable): nick name for the property specified + * @blurb: (nullable): description of the property specified * @type: a #GVariantType * @default_value: (nullable) (transfer full): a #GVariant of type @type to * use as the default value, or %NULL @@ -5017,22 +5018,6 @@ /** - * g_signal_group_connect_closure: - * @self: a #GSignalGroup - * @detailed_signal: a string of the form `signal-name` with optional `::signal-detail` - * @closure: (not nullable): the closure to connect. - * @after: whether the handler should be called before or after the - * default handler of the signal. - * - * Connects @closure to the signal @detailed_signal on #GSignalGroup:target. - * - * You cannot connect a signal handler after #GSignalGroup:target has been set. - * - * Since: 2.74 - */ - - -/** * g_signal_group_connect_data: * @self: a #GSignalGroup * @detailed_signal: a string of the form "signal-name::detail" @@ -5473,7 +5458,7 @@ * an object definition, instead the function pointer is passed * directly and can be overridden by derived classes with * g_signal_override_class_closure() or - * g_signal_override_class_handler()and chained to with + * g_signal_override_class_handler() and chained to with * g_signal_chain_from_overridden() or * g_signal_chain_from_overridden_handler(). * |