GNOME.org
 

[glibmm] Regenerate .docs.xml files.

commit df4b19d02bd37a0affce693db1eccbac05b2331b
Author: Murray Cumming <murrayc murrayc com>
Date:   Mon Jan 18 11:28:34 2016 +0100

    Regenerate .docs.xml files.

 gio/src/gio_docs.xml   |   51 +++++++++++++++++++++++++++++++++++++++++++++--
 glib/src/glib_docs.xml |   16 ++++++++------
 2 files changed, 57 insertions(+), 10 deletions(-)
---
diff --git a/gio/src/gio_docs.xml b/gio/src/gio_docs.xml
index b2d1324..3e7b227 100644
--- a/gio/src/gio_docs.xml
+++ b/gio/src/gio_docs.xml
@@ -5654,7 +5654,11 @@ no one else overrides it.
 
 <property name="GTlsConnection:base-io-stream">
 <description>
-The #GIOStream that the connection wraps
+The #GIOStream that the connection wraps. The connection holds a reference
+to this stream, and may run operations on the stream from other threads
+throughout its lifetime. Consequently, after the #GIOStream has been
+constructed, application code may only run its own operations on this
+stream when no #GIOStream operations are running.
 
 Since: 2.28
 
@@ -8375,6 +8379,17 @@ need to handle these arguments for yourself because once they are
 consumed, they will no longer be visible to the default handling
 (which treats them as filenames to be opened).
 
+It is important to use the proper GVariant format when retrieving
+the options with g_variant_dict_lookup():
+- for %G_OPTION_ARG_NONE, use b
+- for %G_OPTION_ARG_STRING, use &amp;s
+- for %G_OPTION_ARG_INT, use i
+- for %G_OPTION_ARG_INT64, use x
+- for %G_OPTION_ARG_DOUBLE, use d
+- for %G_OPTION_ARG_FILENAME, use ^ay
+- for %G_OPTION_ARG_STRING_ARRAY, use &amp;as
+- for %G_OPTION_ARG_FILENAME_ARRAY, use ^aay
+
 Since: 2.40
 
 </description>
@@ -9359,6 +9374,9 @@ use.
 This function sets the prgname (g_set_prgname()), if not already set,
 to the basename of argv[0].
 
+Much like g_main_loop_run(), this function will acquire the main context
+for the duration that the application is running.
+
 Since 2.40, applications that are not explicitly flagged as services
 or launchers (ie: neither %G_APPLICATION_IS_SERVICE or
 %G_APPLICATION_IS_LAUNCHER are given as flags) will check (from the
@@ -9602,7 +9620,12 @@ the path to %NULL.
 
 Changing the resource base path once the application is running is
 not recommended.  The point at which the resource path is consulted
-for forming paths for various purposes is unspecified.
+for forming paths for various purposes is unspecified.  When writing
+a sub-class of #GApplication you should either set the
+#GApplication:resource-base-path property at construction time, or call
+this function during the instance initialization. Alternatively, you
+can call this function in the #GApplicationClass.startup virtual function,
+before chaining up to the parent implementation.
 
 Since: 2.42
 
@@ -18338,6 +18361,10 @@ or use g_dbus_method_invocation_return_dbus_error().
 
 This method will free @invocation, you cannot use it afterwards.
 
+Since 2.48, if the method call requested for a reply not to be sent
+then this call will free @invocation but otherwise do nothing (as per
+the recommendations of the D-Bus specification).
+
 Since: 2.26
 
 </description>
@@ -18463,6 +18490,11 @@ It is an error if @parameters is not of the right format.
 
 This method will free @invocation, you cannot use it afterwards.
 
+Since 2.48, if the method call requested for a reply not to be sent
+then this call will sink @parameters and free @invocation, but
+otherwise do nothing (as per the recommendations of the D-Bus
+specification).
+
 Since: 2.26
 
 </description>
@@ -29907,6 +29939,7 @@ Since: 2.22
 </parameters>
 <return> a new #GInetAddress corresponding to the &quot;any&quot; address
 for @family.
+Free the returned object with g_object_unref().
 
 </return>
 </function>
@@ -29931,6 +29964,7 @@ Since: 2.22
 </parameter>
 </parameters>
 <return> a new #GInetAddress corresponding to @family and @bytes.
+Free the returned object with g_object_unref().
 
 </return>
 </function>
@@ -29950,6 +29984,7 @@ Since: 2.22
 </parameters>
 <return> a new #GInetAddress corresponding to @string, or %NULL if
 @string could not be parsed.
+Free the returned object with g_object_unref().
 
 </return>
 </function>
@@ -29969,6 +30004,7 @@ Since: 2.22
 </parameters>
 <return> a new #GInetAddress corresponding to the loopback address
 for @family.
+Free the returned object with g_object_unref().
 
 </return>
 </function>
@@ -50339,6 +50375,10 @@ Creates a new #GTlsClientConnection wrapping @base_io_stream (which
 must have pollable input and output streams) which is assumed to
 communicate with the server identified by @server_identity.
 
+See the documentation for #GTlsConnection:base-io-stream for restrictions
+on when application code can run operations on the @base_io_stream after
+this function has returned.
+
 Since: 2.28
 
 </description>
@@ -50879,7 +50919,8 @@ connection; when the application calls g_io_stream_close() itself
 on @conn, this will send a close notification regardless of the
 setting of this property. If you explicitly want to do an unclean
 close, you can close @conn's #GTlsConnection:base-io-stream rather
-than closing @conn itself.
+than closing @conn itself, but note that this may only be done when no other
+operations are pending on @conn or the base I/O stream.
 
 Since: 2.28
 
@@ -52078,6 +52119,10 @@ Since: 2.30
 Creates a new #GTlsServerConnection wrapping @base_io_stream (which
 must have pollable input and output streams).
 
+See the documentation for #GTlsConnection:base-io-stream for restrictions
+on when application code can run operations on the @base_io_stream after
+this function has returned.
+
 Since: 2.28
 
 </description>
diff --git a/glib/src/glib_docs.xml b/glib/src/glib_docs.xml
index 3bcb9b5..13b6369 100644
--- a/glib/src/glib_docs.xml
+++ b/glib/src/glib_docs.xml
@@ -3368,27 +3368,27 @@ Old South Arabian. Since 2.26
 </parameter_description>
 </parameter>
 <parameter name="G_UNICODE_SCRIPT_AHOM">
-<parameter_description>                 Ahom. Since 2.48
+<parameter_description>                 Ahom. Since: 2.48
 </parameter_description>
 </parameter>
 <parameter name="G_UNICODE_SCRIPT_ANATOLIAN_HIEROGLYPHS">
-<parameter_description> Anatolian Hieroglyphs. Since 2.48
+<parameter_description> Anatolian Hieroglyphs. Since: 2.48
 </parameter_description>
 </parameter>
 <parameter name="G_UNICODE_SCRIPT_HATRAN">
-<parameter_description>               Hatran. Since 2.48
+<parameter_description>               Hatran. Since: 2.48
 </parameter_description>
 </parameter>
 <parameter name="G_UNICODE_SCRIPT_MULTANI">
-<parameter_description>              Multani. Since 2.48
+<parameter_description>              Multani. Since: 2.48
 </parameter_description>
 </parameter>
 <parameter name="G_UNICODE_SCRIPT_OLD_HUNGARIAN">
-<parameter_description>        Old Hungarian. Since 2.48
+<parameter_description>        Old Hungarian. Since: 2.48
 </parameter_description>
 </parameter>
 <parameter name="G_UNICODE_SCRIPT_SIGNWRITING">
-<parameter_description>          Signwriting. Since 2.48
+<parameter_description>          Signwriting. Since: 2.48
 </parameter_description>
 </parameter>
 </parameters>
@@ -43886,6 +43886,7 @@ If you want to do translation for no specific locale, and you want it
 to be done independently of the currently locale, specify &quot;C&quot; for
 @from_locale.
 
+Since: 2.40
 
 </description>
 <parameters>
@@ -43899,6 +43900,7 @@ to be done independently of the currently locale, specify &quot;C&quot; for
 </parameter>
 </parameters>
 <return> a string in plain ASCII
+
 </return>
 </function>
 
@@ -59758,7 +59760,7 @@ Since: 2.16
 
 <function name="g_warn_if_reached">
 <description>
-Logs a critical warning.
+Logs a warning.
 
 Since: 2.16
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]