GNOME.org
 

[glibmm] Regenerate .docs.xml

commit 6f720366013e1887374d5736e62030c55bc15df0
Author: Murray Cumming <murrayc murrayc com>
Date:   Mon Dec 15 10:03:53 2014 +0100

    Regenerate .docs.xml

 gio/src/gio_docs.xml   |  141 ++++++++++++++++++++++++++++++++++++++++++++++++
 glib/src/glib_docs.xml |   27 +++++++---
 2 files changed, 161 insertions(+), 7 deletions(-)
---
diff --git a/gio/src/gio_docs.xml b/gio/src/gio_docs.xml
index 1ddcc56..c2d54f7 100644
--- a/gio/src/gio_docs.xml
+++ b/gio/src/gio_docs.xml
@@ -4269,6 +4269,39 @@ file operations on the mount.
 </parameters>
 </enum>
 
+<enum name="GNetworkConnectivity">
+<description>
+The host's network connectivity state, as reported by #GNetworkMonitor.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="G_NETWORK_CONNECTIVITY_LOCAL">
+<parameter_description> The host is not configured with a
+route to the Internet; it may or may not be connected to a local
+network.
+</parameter_description>
+</parameter>
+<parameter name="G_NETWORK_CONNECTIVITY_LIMITED">
+<parameter_description> The host is connected to a network, but
+does not appear to be able to reach the full Internet, perhaps
+due to upstream network problems.
+</parameter_description>
+</parameter>
+<parameter name="G_NETWORK_CONNECTIVITY_PORTAL">
+<parameter_description> The host is behind a captive portal and
+cannot reach the full Internet.
+</parameter_description>
+</parameter>
+<parameter name="G_NETWORK_CONNECTIVITY_FULL">
+<parameter_description> The host is connected to a network, and
+appears to be able to reach the full Internet.
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
 <signal name="GNetworkMonitor::network-changed">
 <description>
 Emitted when the network configuration changes. If @available is
@@ -47835,6 +47868,42 @@ See g_network_monitor_can_reach_async().
 </return>
 </function>
 
+<function name="g_network_monitor_get_connectivity">
+<description>
+Gets a more detailed networking state than
+g_network_monitor_get_network_available().
+
+If #GNetworkMonitor:network-available is %FALSE, then the
+connectivity state will be %G_NETWORK_CONNECTIVITY_LOCAL.
+
+If #GNetworkMonitor:network-available is %TRUE, then the
+connectivity state will be %G_NETWORK_CONNECTIVITY_FULL (if there
+is full Internet connectivity), %G_NETWORK_CONNECTIVITY_LIMITED (if
+the host has a default route, but appears to be unable to actually
+reach the full Internet), or %G_NETWORK_CONNECTIVITY_PORTAL (if the
+host is trapped behind a &quot;captive portal&quot; that requires some sort
+of login or acknowledgement before allowing full Internet access).
+
+Note that in the case of %G_NETWORK_CONNECTIVITY_LIMITED and
+%G_NETWORK_CONNECTIVITY_PORTAL, it is possible that some sites are
+reachable but others are not. In this case, applications can
+attempt to connect to remote servers, but should gracefully fall
+back to their &quot;offline&quot; behavior if the connection attempt fails.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="monitor">
+<parameter_description> the #GNetworkMonitor
+</parameter_description>
+</parameter>
+</parameters>
+<return> the network connectivity state
+
+</return>
+</function>
+
 <function name="g_network_monitor_get_default">
 <description>
 Gets the default #GNetworkMonitor for the system.
@@ -58407,6 +58476,78 @@ on error
 </return>
 </function>
 
+<function name="g_socket_send_messages">
+<description>
+Send multiple data messages from @socket in one go.  This is the most
+complicated and fully-featured version of this call. For easier use, see
+g_socket_send(), g_socket_send_to(), and g_socket_send_message().
+
+ messages must point to an array of #GOutputMessage structs and
+ num_messages must be the length of this array. Each #GOutputMessage
+contains an address to send the data to, and a pointer to an array of
+#GOutputVector structs to describe the buffers that the data to be sent
+for each message will be gathered from. Using multiple #GOutputVectors is
+more memory-efficient than manually copying data from multiple sources
+into a single buffer, and more network-efficient than making multiple
+calls to g_socket_send(). Sending multiple messages in one go avoids the
+overhead of making a lot of syscalls in scenarios where a lot of data
+packets need to be sent (e.g. high-bandwidth video streaming over RTP/UDP),
+or where the same data needs to be sent to multiple recipients.
+
+ flags modify how the message is sent. The commonly available arguments
+for this are available in the #GSocketMsgFlags enum, but the
+values there are the same as the system values, and the flags
+are passed in as-is, so you can pass in system-specific flags too.
+
+If the socket is in blocking mode the call will block until there is
+space for all the data in the socket queue. If there is no space available
+and the socket is in non-blocking mode a %G_IO_ERROR_WOULD_BLOCK error
+will be returned if no data was written at all, otherwise the number of
+messages sent will be returned. To be notified when space is available,
+wait for the %G_IO_OUT condition. Note though that you may still receive
+%G_IO_ERROR_WOULD_BLOCK from g_socket_send() even if you were previously
+notified of a %G_IO_OUT condition. (On Windows in particular, this is
+very common due to the way the underlying APIs work.)
+
+On error -1 is returned and @error is set accordingly.
+
+Since: 2.44
+
+</description>
+<parameters>
+<parameter name="socket">
+<parameter_description> a #GSocket
+</parameter_description>
+</parameter>
+<parameter name="messages">
+<parameter_description> an array of #GOutputMessage structs
+</parameter_description>
+</parameter>
+<parameter name="num_messages">
+<parameter_description> the number of elements in @messages
+</parameter_description>
+</parameter>
+<parameter name="flags">
+<parameter_description> an int containing #GSocketMsgFlags flags
+</parameter_description>
+</parameter>
+<parameter name="cancellable">
+<parameter_description> a %GCancellable or %NULL
+</parameter_description>
+</parameter>
+<parameter name="error">
+<parameter_description> #GError for error reporting, or %NULL to ignore.
+</parameter_description>
+</parameter>
+</parameters>
+<return> number of messages sent, or -1 on error. Note that the number of
+messages sent may be smaller than @num_messages if the socket is
+non-blocking or if @num_messages was larger than UIO_MAXIOV (1024),
+in which case the caller may re-try to send the remaining messages.
+
+</return>
+</function>
+
 <function name="g_socket_send_to">
 <description>
 Tries to send @size bytes from @buffer to @address. If @address is
diff --git a/glib/src/glib_docs.xml b/glib/src/glib_docs.xml
index e0ff2b8..3660e8f 100644
--- a/glib/src/glib_docs.xml
+++ b/glib/src/glib_docs.xml
@@ -2811,7 +2811,7 @@ a value never returned from g_unichar_get_script()
 </parameter>
 <parameter name="G_UNICODE_SCRIPT_INHERITED">
 <parameter_description>  a mark glyph that takes its script from the
-i                             base glyph to which it is attached
+base glyph to which it is attached
 </parameter_description>
 </parameter>
 <parameter name="G_UNICODE_SCRIPT_ARABIC">
@@ -3314,7 +3314,10 @@ Old South Arabian. Since 2.26
 </parameter>
 <parameter name="G_UNICODE_SCRIPT_TIRHUTA">
 <parameter_description>              Tirhuta. Since: 2.42
- G_UNICODE_SCRIPT_WARANG_CITI           Warang Citi. Since: 2.42
+</parameter_description>
+</parameter>
+<parameter name="G_UNICODE_SCRIPT_WARANG_CITI">
+<parameter_description>          Warang Citi. Since: 2.42
 </parameter_description>
 </parameter>
 </parameters>
@@ -10517,7 +10520,9 @@ Since: 2.36
 </parameter_description>
 </parameter>
 </parameters>
-<return></return>
+<return> %TRUE on success, %FALSE if there was an error.
+
+</return>
 </function>
 
 <function name="g_closure_add_finalize_notifier">
@@ -17158,7 +17163,9 @@ Since: 2.32
 </parameter_description>
 </parameter>
 </parameters>
-<return></return>
+<return> %TRUE if @key is in @hash_table, %FALSE otherwise.
+
+</return>
 </function>
 
 <function name="g_hash_table_destroy">
@@ -17357,7 +17364,7 @@ key.  Use @length to determine the true length if it's possible that
 %NULL was used as the value for a key.
 
 Note: in the common case of a string-keyed #GHashTable, the return
-value of this function can be conveniently cast to (gchar **).
+value of this function can be conveniently cast to (const gchar **).
 
 You should always free the return result with g_free().  In the
 above-mentioned case of a string-keyed hash table, it may be
@@ -28951,7 +28958,9 @@ Since: 2.44
 </parameter_description>
 </parameter>
 </parameters>
-<return></return>
+<return> %TRUE if strict POSIX is enabled, %FALSE otherwise.
+
+</return>
 </function>
 
 <function name="g_option_context_get_summary">
@@ -29238,6 +29247,10 @@ Since: 2.44
 <parameter_description> a #GoptionContext
 </parameter_description>
 </parameter>
+<parameter name="strict_posix">
+<parameter_description> the new value
+</parameter_description>
+</parameter>
 </parameters>
 <return></return>
 </function>
@@ -58402,7 +58415,7 @@ Values of this type can range from #G_MINSSIZE
 to #G_MAXSSIZE.
 
 To print or scan values of this type, use
-%G_GSIZE_MODIFIER and/or %G_GSSIZE_FORMAT.
+%G_GSSIZE_MODIFIER and/or %G_GSSIZE_FORMAT.
 
 </description>
 <parameters>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]