[glibmm] Glib, Gio: Regenerate docs.xml files



commit bb1c06c612f803c7ddd7704620df12eb6f4d790c
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date:   Mon Sep 19 10:34:18 2022 +0200

    Glib, Gio: Regenerate docs.xml files
    
    using gtk files from glib 2.74.0.

 gio/src/gio_docs.xml   | 20 ++++++++++++++++++--
 glib/src/glib_docs.xml | 44 +++++++++++++++++++++++++++++++++-----------
 2 files changed, 51 insertions(+), 13 deletions(-)
---
diff --git a/gio/src/gio_docs.xml b/gio/src/gio_docs.xml
index 83a43911..1644cc42 100644
--- a/gio/src/gio_docs.xml
+++ b/gio/src/gio_docs.xml
@@ -185,6 +185,10 @@ The #GAppLaunchContext::launch-failed signal is emitted when a #GAppInfo launch
 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
 
 </description>
@@ -218,6 +222,10 @@ It allows tracking the progress of the launchee through startup.
 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
 
 </description>
@@ -241,7 +249,13 @@ Since: 2.72
 <signal name="GAppLaunchContext::launched">
 <description>
 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.
@@ -9245,7 +9259,9 @@ Since: 2.50
 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.
 
diff --git a/glib/src/glib_docs.xml b/glib/src/glib_docs.xml
index 285fc791..be64a186 100644
--- a/glib/src/glib_docs.xml
+++ b/glib/src/glib_docs.xml
@@ -4470,6 +4470,9 @@ bytes, but care is taken to align the allocated memory to with the given
 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().
 
@@ -30120,6 +30123,9 @@ Deprecated: 2.2: Use g_main_context_set_poll_func() again
 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.
+
 
 </description>
 <parameters>
@@ -30137,6 +30143,9 @@ If @n_bytes is 0 it returns %NULL.
 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.
+
 
 </description>
 <parameters>
@@ -30154,6 +30163,9 @@ If @n_bytes is 0 it returns %NULL.
 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
 
 </description>
@@ -30176,6 +30188,9 @@ Since: 2.24
 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
 
 </description>
@@ -36595,11 +36610,12 @@ See [canonical parameter names][canonical-parameter-names] for details of
 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.
 
 
 </description>
@@ -40918,6 +40934,9 @@ have been moved. @mem may be %NULL, in which case it's considered to
 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.
+
 
 </description>
 <parameters>
@@ -40939,6 +40958,9 @@ and @mem will be freed unless it is %NULL.
 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
 
 </description>
@@ -46634,7 +46656,7 @@ doesn't need a function pointer exposed in the class structure of
 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().
 
@@ -60688,11 +60710,11 @@ invoked g_unix_signal_source_new().
 
 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.


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]