[glibmm] Regenerate *_docs.xml files.



commit a4695d98322d7d2e8c0a64dc5cb26e10e3dedb1e
Author: Murray Cumming <murrayc murrayc com>
Date:   Sat Aug 15 13:25:49 2015 +0200

    Regenerate *_docs.xml files.

 gio/src/gio_docs.xml   |   63 +++++++++++++++++++++++++++++++++++++++++++++--
 glib/src/glib_docs.xml |   57 ++++++++++++++++--------------------------
 2 files changed, 82 insertions(+), 38 deletions(-)
---
diff --git a/gio/src/gio_docs.xml b/gio/src/gio_docs.xml
index 9f9a22c..079cc9b 100644
--- a/gio/src/gio_docs.xml
+++ b/gio/src/gio_docs.xml
@@ -284,8 +284,8 @@ decide to perform certain actions, including direct local handling
 
 In the event that the application is marked
 %G_APPLICATION_HANDLES_COMMAND_LINE the &quot;normal processing&quot; will
-send the @option dictionary to the primary instance where it can be
-read with g_application_command_line_get_options().  The signal
+send the @options dictionary to the primary instance where it can be
+read with g_application_command_line_get_options_dict().  The signal
 handler can modify the dictionary before returning, and the
 modified dictionary will be sent.
 
@@ -3928,6 +3928,31 @@ Since: 2.32
 </description>
 </property>
 
+<property name="GNetworkMonitor:network-metered">
+<description>
+Whether the network is considered metered. That is, whether the
+system has traffic flowing through the default connection that is
+subject to limitations set by service providers. For example, traffic
+might be billed by the amount of data transmitted, or there might be a
+quota on the amount of traffic per month. This is typical with tethered
+connections (3G and 4G) and in such situations, bandwidth intensive
+applications may wish to avoid network activity where possible if it will
+cost the user money or use up their limited quota.
+
+If more information is required about specific devices then the
+system network management API should be used instead (for example,
+NetworkManager or ConnMan).
+
+If this information is not available then no networks will be
+marked as metered.
+
+See also #GNetworkMonitor:network-available.
+
+Since: 2.46
+
+</description>
+</property>
+
 <enum name="GNotificationPriority">
 <description>
 Priority levels for #GNotifications.
@@ -5121,6 +5146,15 @@ g_socket_listener_add_address()
 </return>
 </signal>
 
+<property name="GSocketService:active">
+<description>
+Whether the service is currently accepting connections.
+
+Since: 2.46
+
+</description>
+</property>
+
 <enum name="GSocketType">
 <description>
 Flags used when creating a #GSocket. Some protocols may not implement
@@ -15271,7 +15305,8 @@ to match on all kinds of arguments
 </parameter_description>
 </parameter>
 <parameter name="flags">
-<parameter_description> flags describing how to subscribe to the signal (currently unused)
+<parameter_description> #GDBusSignalFlags describing how arg0 is used in subscribing to the
+signal
 </parameter_description>
 </parameter>
 <parameter name="callback">
@@ -35272,6 +35307,25 @@ Since: 2.32
 </return>
 </function>
 
+<function name="g_network_monitor_get_network_metered">
+<description>
+Checks if the network is metered.
+See #GNetworkMonitor:network-metered for more details.
+
+Since: 2.46
+
+</description>
+<parameters>
+<parameter name="monitor">
+<parameter_description> the #GNetworkMonitor
+</parameter_description>
+</parameter>
+</parameters>
+<return> whether the connection is metered
+
+</return>
+</function>
+
 <function name="g_network_service_get_domain">
 <description>
 Gets the domain that @srv serves. This might be either UTF-8 or
@@ -38594,6 +38648,9 @@ Returns all the names of children at the specified @path in the resource.
 The return result is a %NULL terminated list of strings which should
 be released with g_strfreev().
 
+If @path is invalid or does not exist in the #GResource,
+%G_RESOURCE_ERROR_NOT_FOUND will be returned.
+
 @lookup_flags controls the behaviour of the lookup.
 
 Since: 2.32
diff --git a/glib/src/glib_docs.xml b/glib/src/glib_docs.xml
index 1708607..20cd348 100644
--- a/glib/src/glib_docs.xml
+++ b/glib/src/glib_docs.xml
@@ -5652,7 +5652,7 @@ lock.
 
 <function name="g_async_queue_remove">
 <description>
-Remove an item from the queue. This function does not block.
+Remove an item from the queue.
 
 Since: 2.46
 
@@ -5674,7 +5674,7 @@ Since: 2.46
 
 <function name="g_async_queue_remove_unlocked">
 <description>
-Remove an item from the queue. This function does not block.
+Remove an item from the queue.
 
 This function must be called while holding the @queue's lock.
 
@@ -19239,7 +19239,7 @@ If you supplied a @key_destroy_func when creating the
 </parameter_description>
 </parameter>
 </parameters>
-<return> %TRUE of the key did not exist yet
+<return> %TRUE if the key did not exist yet
 </return>
 </function>
 
@@ -26833,28 +26833,24 @@ malloc() can be used interchangeable with memory allocated using g_malloc().
 This function is useful for avoiding an extra copy of allocated memory returned
 by a non-GLib-based API.
 
-A different allocator can be set using g_mem_set_vtable().
-
+Deprecated: 2.46: GLib always uses the system malloc, so this function always
+returns %TRUE.
 
 </description>
 <parameters>
 </parameters>
 <return> if %TRUE, malloc() and g_malloc() can be mixed.
+
 </return>
 </function>
 
 <function name="g_mem_profile">
 <description>
-Outputs a summary of memory usage.
-
-It outputs the frequency of allocations of different sizes,
-the total number of bytes which have been allocated,
-the total number of bytes which have been freed,
-and the difference between the previous two values, i.e. the number of bytes
-still in use.
+GLib used to support some tools for memory profiling, but this
+no longer works. There are many other useful tools for memory
+profiling these days which can be used instead.
 
-Note that this function will not output anything unless you have
-previously installed the #glib_mem_profiler_table with g_mem_set_vtable().
+Deprecated: 2.46: Use other memory profiling tools instead
 
 </description>
 <parameters>
@@ -26864,17 +26860,12 @@ previously installed the #glib_mem_profiler_table with g_mem_set_vtable().
 
 <function name="g_mem_set_vtable">
 <description>
-Sets the #GMemVTable to use for memory allocation. You can use this
-to provide custom memory allocation routines.
+This function used to let you override the memory allocation function.
+However, its use was incompatible with the use of global constructors
+in GLib and GIO, because those use the GLib allocators before main is
+reached. Therefore this function is now deprecated and is just a stub.
 
-The @vtable only needs to provide malloc(), realloc(), and free()
-functions; GLib can provide default implementations of the others.
-The malloc() and realloc() implementations should return %NULL on
-failure, GLib will handle error-checking for you. @vtable is copied,
-so need not persist after this function has been called.
-
-Note that this function must be called before using any other GLib
-functions.
+Deprecated: 2.46: Use other memory profiling tools instead
 
 </description>
 <parameters>
@@ -42347,13 +42338,8 @@ tools it is enough to make the program have a wmain() instead of
 main(). wmain() has a wide character argument vector as parameter.
 
 At least currently, mingw doesn't support wmain(), so if you use
-mingw to develop the spawned program, it will have to call the
-undocumented function __wgetmainargs() to get the wide character
-argument vector and environment. See gspawn-win32-helper.c in the
-GLib sources or init.c in the mingw runtime sources for a prototype
-for that function. Alternatively, you can retrieve the Win32 system
-level wide character command line passed to the spawned program
-using the GetCommandLineW() function.
+mingw to develop the spawned program, it should call
+g_win32_get_command_line() to get arguments in UTF-8.
 
 On Windows the low-level child process creation API CreateProcess()
 doesn't use argument vectors, but a command line. The C runtime
@@ -43508,6 +43494,10 @@ uses the signed value of each byte.
 It can be passed to g_hash_table_new() as the @hash_func parameter,
 when using non-%NULL strings as keys in a #GHashTable.
 
+Note that this function may not be a perfect fit for all use cases.
+For example, it produces some hash collisions with strings as short
+as 2.
+
 
 </description>
 <parameters>
@@ -60058,10 +60048,7 @@ against at application run time.
 
 <function name="glib_mem_profiler_table">
 <description>
-A #GMemVTable containing profiling variants of the memory
-allocation functions. Use them together with g_mem_profile()
-in order to get information about the memory allocation pattern
-of your program.
+Deprecated: 2.46: Use other memory profiling tools instead
 
 </description>
 <parameters>


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