summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMurray Cumming <murrayc@murrayc.com>2015-08-20 11:37:16 +0200
committerMurray Cumming <murrayc@murrayc.com>2015-08-20 11:37:16 +0200
commit2d422b5b8d52fe4b0fead17b5b55d0aa8cab623f (patch)
treedce08a2e493178609ceecd67490016bcedcffe1e
parent556d66ea4fe43de1f0acdd37adff31d71e4f4eb2 (diff)
downloadglibmm-2d422b5b8d52fe4b0fead17b5b55d0aa8cab623f.tar.gz
Regenerate _docs.xml files.
-rw-r--r--gio/src/gio_docs.xml44
-rw-r--r--glib/src/glib_docs.xml45
2 files changed, 86 insertions, 3 deletions
diff --git a/gio/src/gio_docs.xml b/gio/src/gio_docs.xml
index 079cc9ba..c92519c8 100644
--- a/gio/src/gio_docs.xml
+++ b/gio/src/gio_docs.xml
@@ -14887,6 +14887,50 @@ that can be used with g_dbus_connection_unregister_object()
</return>
</function>
+<function name="g_dbus_connection_register_object_with_closures">
+<description>
+Version of g_dbus_connection_register_object() using closures instead of a
+#GDBusInterfaceVTable for easier binding in other languages.
+
+Since: 2.46
+
+</description>
+<parameters>
+<parameter name="connection">
+<parameter_description> A #GDBusConnection.
+</parameter_description>
+</parameter>
+<parameter name="object_path">
+<parameter_description> The object path to register at.
+</parameter_description>
+</parameter>
+<parameter name="interface_info">
+<parameter_description> Introspection data for the interface.
+</parameter_description>
+</parameter>
+<parameter name="method_call_closure">
+<parameter_description> #GClosure for handling incoming method calls.
+</parameter_description>
+</parameter>
+<parameter name="get_property_closure">
+<parameter_description> #GClosure for getting a property.
+</parameter_description>
+</parameter>
+<parameter name="set_property_closure">
+<parameter_description> #GClosure for setting a property.
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> Return location for error or %NULL.
+</parameter_description>
+</parameter>
+</parameters>
+<return> 0 if @error is set, otherwise a registration id (never 0)
+that can be used with g_dbus_connection_unregister_object() .
+
+</return>
+</function>
+
<function name="g_dbus_connection_register_subtree">
<description>
Registers a whole subtree of dynamic objects.
diff --git a/glib/src/glib_docs.xml b/glib/src/glib_docs.xml
index 20cd3484..e8d68345 100644
--- a/glib/src/glib_docs.xml
+++ b/glib/src/glib_docs.xml
@@ -16908,6 +16908,10 @@ updated environment list. Free it using g_strfreev().
<description>
A convenience function/macro to log an error message.
+This is not intended for end user error reporting. Use of #GError is
+preferred for that instead, as it allows calling functions to perform actions
+conditional on the type of error.
+
Error messages are always fatal, resulting in a call to
abort() to terminate the application. This function will
result in a core dump; don't use it for errors you expect.
@@ -20290,6 +20294,9 @@ default idle priority, #G_PRIORITY_DEFAULT_IDLE. If the function
returns %FALSE it is automatically removed from the list of event
sources and will not be called again.
+See [memory management of sources][mainloop-memory-management] for details
+on how to handle the return value and memory management of @data.
+
This internally creates a main loop source using g_idle_source_new()
and attaches it to the global #GMainContext using g_source_attach(), so
the callback will be invoked in whichever thread is running that main
@@ -20318,6 +20325,9 @@ Adds a function to be called whenever there are no higher priority
events pending. If the function returns %FALSE it is automatically
removed from the list of event sources and will not be called again.
+See [memory management of sources][mainloop-memory-management] for details
+on how to handle the return value and memory management of @data.
+
This internally creates a main loop source using g_idle_source_new()
and attaches it to the global #GMainContext using g_source_attach(), so
the callback will be invoked in whichever thread is running that main
@@ -38843,6 +38853,9 @@ Connects a #GCallback function to a signal for a particular object.
The handler will be called before the default handler of the signal.
+See [memory management of signal handlers][signal-memory-management] for
+details on how to handle the return value and memory management of @data.
+
</description>
<parameters>
@@ -41937,6 +41950,9 @@ The exact type of @func depends on the type of source; ie. you
should not count on @func being called with @data as its first
parameter.
+See [memory management of sources][mainloop-memory-management] for details
+on how to handle memory management of @data.
+
Typically, you won't use this function. Instead use functions specific
to the type of source you are using.
@@ -47338,6 +47354,10 @@ Some systems restrict the length of @name to 16 bytes.
If the thread can not be created the program aborts. See
g_thread_try_new() if you want to attempt to deal with failures.
+If you are using threads to offload (potentially many) short-lived tasks,
+#GThreadPool may be more appropriate than manually spawning and tracking
+multiple #GThreads.
+
To free the struct returned by this function, use g_thread_unref().
Note that g_thread_join() implicitly unrefs the #GThread as well.
@@ -48305,6 +48325,9 @@ After each call to the timeout function, the time of the next
timeout is recalculated based on the current time and the given interval
(it does not try to 'catch up' time lost in delays).
+See [memory management of sources][mainloop-memory-management] for details
+on how to handle the return value and memory management of @data.
+
If you want to have a timer in the &quot;seconds&quot; range and do not care
about the exact time of the first call of the timer, use the
g_timeout_add_seconds() function; this function allows for more
@@ -48355,6 +48378,9 @@ After each call to the timeout function, the time of the next
timeout is recalculated based on the current time and the given interval
(it does not try to 'catch up' time lost in delays).
+See [memory management of sources][mainloop-memory-management] for details
+on how to handle the return value and memory management of @data.
+
This internally creates a main loop source using g_timeout_source_new()
and attaches it to the global #GMainContext using g_source_attach(), so
the callback will be invoked in whichever thread is running that main
@@ -48410,6 +48436,9 @@ Note that the first call of the timer may not be precise for timeouts
of one second. If you need finer precision and have such a timeout,
you may want to use g_timeout_add() instead.
+See [memory management of sources][mainloop-memory-management] for details
+on how to handle the return value and memory management of @data.
+
The interval given is in terms of monotonic time, not wall clock
time. See g_get_monotonic_time().
@@ -48455,6 +48484,9 @@ event sources. Thus they should not be relied on for precise timing.
After each call to the timeout function, the time of the next
timeout is recalculated based on the current time and the given @interval
+See [memory management of sources][mainloop-memory-management] for details
+on how to handle the return value and memory management of @data.
+
If you want timing more precise than whole seconds, use g_timeout_add()
instead.
@@ -56295,7 +56327,7 @@ Returns the string value of a #GVariant instance with a string
type. This includes the types %G_VARIANT_TYPE_STRING,
%G_VARIANT_TYPE_OBJECT_PATH and %G_VARIANT_TYPE_SIGNATURE.
-The string will always be UTF-8 encoded.
+The string will always be UTF-8 encoded, and will never be %NULL.
If @length is non-%NULL then the length of the string (in bytes) is
returned there. For trusted values, this information is already
@@ -57782,7 +57814,9 @@ Since: 2.24
<description>
Creates a string #GVariant with the contents of @string.
-@string must be valid UTF-8.
+@string must be valid UTF-8, and must not be %NULL. To encode
+potentially-%NULL strings, use g_variant_new() with `ms` as the
+[format string][gvariant-format-strings-maybe-types].
Since: 2.24
@@ -57827,7 +57861,8 @@ Since: 2.24
<description>
Creates a string #GVariant with the contents of @string.
-@string must be valid UTF-8.
+@string must be valid UTF-8, and must not be %NULL. To encode
+potentially-%NULL strings, use this with g_variant_new_maybe().
This function consumes @string. g_free() will be called on @string
when it is no longer required.
@@ -59333,6 +59368,10 @@ Since: 2.16
<description>
A convenience function/macro to log a warning message.
+This is not intended for end user error reporting. Use of #GError is
+preferred for that instead, as it allows calling functions to perform actions
+conditional on the type of error.
+
You can make warnings fatal at runtime by setting the `G_DEBUG`
environment variable (see
[Running GLib Applications](glib-running.html)).