summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2022-09-02 13:02:41 +0100
committerEmmanuele Bassi <ebassi@gnome.org>2022-09-02 13:02:41 +0100
commitf36892954302b52a027073a96a6d61b0feea6f8d (patch)
treec8555429940741554179005898b8eb9aaf194f84
parentf02d7740b7ee40f83708c1d79d40e43deb55952b (diff)
downloadgobject-introspection-f36892954302b52a027073a96a6d61b0feea6f8d.tar.gz
Update GLib annotations
GLib commit: 2.73.3-44-g66c4e35e2
-rw-r--r--gir/gio-2.0.c22
-rw-r--r--gir/glib-2.0.c21
-rw-r--r--gir/gobject-2.0.c103
3 files changed, 92 insertions, 54 deletions
diff --git a/gir/gio-2.0.c b/gir/gio-2.0.c
index 8f58cb73..1397c88c 100644
--- a/gir/gio-2.0.c
+++ b/gir/gio-2.0.c
@@ -243,6 +243,10 @@
* fails. The startup notification id is provided, so that the launcher
* can cancel the startup notification.
*
+ * Because a launch operation may involve spawning multiple instances of the
+ * target application, you should expect this signal to be emitted multiple
+ * times, one for each spawned instance.
+ *
* Since: 2.36
*/
@@ -268,6 +272,10 @@
* It is guaranteed that this signal is followed by either a #GAppLaunchContext::launched or
* #GAppLaunchContext::launch-failed signal.
*
+ * Because a launch operation may involve spawning multiple instances of the
+ * target application, you should expect this signal to be emitted multiple
+ * times, one for each spawned instance.
+ *
* Since: 2.72
*/
@@ -279,7 +287,13 @@
* @platform_data: additional platform-specific data for this launch
*
* The #GAppLaunchContext::launched signal is emitted when a #GAppInfo is successfully
- * launched. The @platform_data is an GVariant dictionary mapping
+ * launched.
+ *
+ * Because a launch operation may involve spawning multiple instances of the
+ * target application, you should expect this signal to be emitted multiple
+ * times, one time for each spawned instance.
+ *
+ * The @platform_data is an GVariant dictionary mapping
* strings to variants (ie `a{sv}`), which contains additional,
* platform-specific data about this launch. On UNIX, at least the
* `pid` and `startup-notification-id` keys will be present.
@@ -12082,7 +12096,9 @@
* Launches the application. This passes the @uris to the launched application
* as arguments, using the optional @context to get information
* about the details of the launcher (like what screen it is on).
- * On error, @error will be set accordingly.
+ * On error, @error will be set accordingly. If the application only supports
+ * one URI per invocation as part of their command-line, multiple instances
+ * of the application will be spawned.
*
* To launch the application without arguments pass a %NULL @uris list.
*
@@ -40849,7 +40865,7 @@
* check a certificate against a CA that is not part of the system
* CA database.
*
- * If @cert is valid, %G_TLS_CERTIFICATE_FLAGS_NONE is returned.
+ * If @cert is valid, %G_TLS_CERTIFICATE_NO_FLAGS is returned.
*
* If @identity is not %NULL, @cert's name(s) will be compared against
* it, and %G_TLS_CERTIFICATE_BAD_IDENTITY will be set in the return
diff --git a/gir/glib-2.0.c b/gir/glib-2.0.c
index 9f928323..2b5028f6 100644
--- a/gir/glib-2.0.c
+++ b/gir/glib-2.0.c
@@ -9233,6 +9233,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().
*
@@ -23295,6 +23298,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
*/
@@ -23306,6 +23312,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
*/
@@ -23318,6 +23327,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
*/
@@ -23331,6 +23343,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
*/
@@ -27697,6 +27712,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
*/
@@ -27710,6 +27728,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
*/
diff --git a/gir/gobject-2.0.c b/gir/gobject-2.0.c
index 4a0cc83a..1ab2dbb2 100644
--- a/gir/gobject-2.0.c
+++ b/gir/gobject-2.0.c
@@ -3926,8 +3926,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
*
@@ -3946,8 +3946,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
*
@@ -3963,8 +3963,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
@@ -3979,8 +3979,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
@@ -3998,8 +3998,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
@@ -4016,8 +4016,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
@@ -4034,8 +4034,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
@@ -4138,8 +4138,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
@@ -4157,8 +4157,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
@@ -4175,8 +4175,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
@@ -4194,8 +4194,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.
@@ -4204,11 +4204,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
@@ -4234,8 +4235,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
@@ -4252,8 +4253,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
*
@@ -4283,8 +4284,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
*
@@ -4300,8 +4301,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.
@@ -4475,8 +4476,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
*
@@ -4491,8 +4492,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
@@ -4507,8 +4508,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
@@ -4525,8 +4526,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
@@ -4544,8 +4545,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
@@ -4563,8 +4564,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
*
@@ -4589,8 +4590,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
@@ -4609,8 +4610,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