diff options
author | Rico Tzschichholz <ricotz@ubuntu.com> | 2016-05-18 08:28:11 +0200 |
---|---|---|
committer | Rico Tzschichholz <ricotz@ubuntu.com> | 2016-05-18 08:28:11 +0200 |
commit | dcbaf7fe5a869535f73202d0a66fe060f1fc78c2 (patch) | |
tree | 7e615a60d6fa3f9e32bda827134acf1f0580af7b | |
parent | 7baef5d317ceda2d8af153b6e48e962a08d04a5e (diff) | |
download | gobject-introspection-dcbaf7fe5a869535f73202d0a66fe060f1fc78c2.tar.gz |
gir: Update annotations from GLib git master
-rw-r--r-- | gir/gio-2.0.c | 102 | ||||
-rw-r--r-- | gir/glib-2.0.c | 37 | ||||
-rw-r--r-- | gir/gobject-2.0.c | 4 |
3 files changed, 137 insertions, 6 deletions
diff --git a/gir/gio-2.0.c b/gir/gio-2.0.c index 5827a2a9..fd73c78d 100644 --- a/gir/gio-2.0.c +++ b/gir/gio-2.0.c @@ -7322,6 +7322,34 @@ * when the library is unloaded. However, in practice this is not generally a problem, since most resource accesses * is for your own resources, and resource data is often used once, during parsing, and then released. * + * When debugging a program or testing a change to an installed version, it is often useful to be able to + * replace resources in the program or library, without recompiling, for debugging or quick hacking and testing + * purposes. + * + * Since GLib 2.50, it is possible to use the `G_RESOURCE_OVERLAYS` environment variable to selectively overlay + * resources with replacements from the filesystem. It is a colon-separated list of substitutions to perform + * during resource lookups. + * + * A substitution has the form + * + * |[ + * /org/gtk/libgtk=/home/desrt/gtk-overlay + * ]| + * + * The part before the `=` is the resource subpath for which the overlay applies. The part after is a + * filesystem path which contains files and subdirectories as you would like to be loaded as resources with the + * equivalent names. + * + * In the example above, if an application tried to load a resource with the resource path + * `/org/gtk/libgtk/ui/gtkdialog.ui` then GResource would check the filesystem path + * `/home/desrt/gtk-overlay/ui/gtkdialog.ui`. If a file was found there, it would be used instead. This is an + * overlay, not an outright replacement, which means that if a file is not found at that path, the built-in + * version will be used instead. Whiteouts are not currently supported. + * + * Substitutions must start with a slash, and must not contain a trailing slash before the '='. The path after + * the slash should ideally be absolute, but this is not strictly required. It is possible to overlay the + * location of a single resource with an individual file. + * * Since: 2.32 */ @@ -32523,6 +32551,23 @@ /** + * g_settings_get_int64: + * @settings: a #GSettings object + * @key: the key to get the value for + * + * Gets the value that is stored at @key in @settings. + * + * A convenience variant of g_settings_get() for 64-bit integers. + * + * It is a programmer error to give a @key that isn't specified as + * having a int64 type in the schema for @settings. + * + * Returns: a 64-bit integer + * Since: 2.50 + */ + + +/** * g_settings_get_mapped: * @settings: a #GSettings object * @key: the key to get the value for @@ -32627,6 +32672,24 @@ /** + * g_settings_get_uint64: + * @settings: a #GSettings object + * @key: the key to get the value for + * + * Gets the value that is stored at @key in @settings. + * + * A convenience variant of g_settings_get() for 64-bit unsigned + * integers. + * + * It is a programmer error to give a @key that isn't specified as + * having a uint64 type in the schema for @settings. + * + * Returns: a 64-bit unsigned integer + * Since: 2.50 + */ + + +/** * g_settings_get_user_value: * @settings: a #GSettings object * @key: the key to get the user value for @@ -33436,6 +33499,25 @@ /** + * g_settings_set_int64: + * @settings: a #GSettings object + * @key: the name of the key to set + * @value: the value to set it to + * + * Sets @key in @settings to @value. + * + * A convenience variant of g_settings_set() for 64-bit integers. + * + * It is a programmer error to give a @key that isn't specified as + * having a int64 type in the schema for @settings. + * + * Returns: %TRUE if setting the key succeeded, + * %FALSE if the key was not writable + * Since: 2.50 + */ + + +/** * g_settings_set_string: * @settings: a #GSettings object * @key: the name of the key to set @@ -33495,6 +33577,26 @@ /** + * g_settings_set_uint64: + * @settings: a #GSettings object + * @key: the name of the key to set + * @value: the value to set it to + * + * Sets @key in @settings to @value. + * + * A convenience variant of g_settings_set() for 64-bit unsigned + * integers. + * + * It is a programmer error to give a @key that isn't specified as + * having a uint64 type in the schema for @settings. + * + * Returns: %TRUE if setting the key succeeded, + * %FALSE if the key was not writable + * Since: 2.50 + */ + + +/** * g_settings_set_value: * @settings: a #GSettings object * @key: the name of the key to set diff --git a/gir/glib-2.0.c b/gir/glib-2.0.c index 9fc4beb1..96d8f494 100644 --- a/gir/glib-2.0.c +++ b/gir/glib-2.0.c @@ -8291,6 +8291,21 @@ /** + * g_abort: + * + * A wrapper for the POSIX abort() function. + * + * On Windows it is a function that makes extra effort (including a call + * to abort()) to ensure that a debugger-catchable exception is thrown + * before the program terminates. + * + * See your C library manual for more details about abort(). + * + * Since: 2.50 + */ + + +/** * g_access: * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows) * @mode: as in access() @@ -19617,9 +19632,20 @@ * Normally you would call this function shortly after creating a new * thread, passing it a #GMainContext which will be run by a * #GMainLoop in that thread, to set a new default context for all - * async operations in that thread. (In this case, you don't need to - * ever call g_main_context_pop_thread_default().) In some cases - * however, you may want to schedule a single operation in a + * async operations in that thread. In this case you may not need to + * ever call g_main_context_pop_thread_default(), assuming you want the + * new #GMainContext to be the default for the whole lifecycle of the + * thread. + * + * If you don't have control over how the new thread was created (e.g. + * in the new thread isn't newly created, or if the thread life + * cycle is managed by a #GThreadPool), it is always suggested to wrap + * the logic that needs to use the new #GMainContext inside a + * g_main_context_push_thread_default() / g_main_context_pop_thread_default() + * pair, otherwise threads that are re-used will end up never explicitly + * releasing the #GMainContext reference they hold. + * + * In some cases you may want to schedule a single operation in a * non-default context, or temporarily use a non-default context in * the main thread. In that case, you can wrap the call to the * asynchronous operation inside a @@ -33099,7 +33125,10 @@ * It is not permissible to use @builder in any way after this call * except for reference counting operations (in the case of a * heap-allocated #GVariantBuilder) or by reinitialising it with - * g_variant_builder_init() (in the case of stack-allocated). + * g_variant_builder_init() (in the case of stack-allocated). This + * means that for the stack-allocated builders there is no need to + * call g_variant_builder_clear() after the call to + * g_variant_builder_end(). * * It is an error to call this function in any way that would create an * inconsistent value to be constructed (ie: insufficient number of diff --git a/gir/gobject-2.0.c b/gir/gobject-2.0.c index 37f7acd2..dd4454c1 100644 --- a/gir/gobject-2.0.c +++ b/gir/gobject-2.0.c @@ -6855,8 +6855,8 @@ * * Check whether g_value_transform() is able to transform values * of type @src_type into values of type @dest_type. Note that for - * the types to be transformable, they must be compatible and a - * transform function must be registered. + * the types to be transformable, they must be compatible or a + * transformation function must be registered. * * Returns: %TRUE if the transformation is possible, %FALSE otherwise. */ |