diff options
author | Rico Tzschichholz <ricotz@ubuntu.com> | 2018-01-08 22:24:42 +0100 |
---|---|---|
committer | Rico Tzschichholz <ricotz@ubuntu.com> | 2018-01-08 22:24:42 +0100 |
commit | 8781ea4a5b437d96a4b3b50eea6f917f8246d6bd (patch) | |
tree | 535656f6ea046ce5c2aa7062ff22caa827039fe5 /gir | |
parent | fd78c996bb204525b217c5baf6704f777ef8c5fa (diff) | |
download | gobject-introspection-8781ea4a5b437d96a4b3b50eea6f917f8246d6bd.tar.gz |
gir: Update annotations from GLib 2.55.1
Diffstat (limited to 'gir')
-rw-r--r-- | gir/gio-2.0.c | 77 | ||||
-rw-r--r-- | gir/glib-2.0.c | 23 | ||||
-rw-r--r-- | gir/gobject-2.0.c | 20 |
3 files changed, 107 insertions, 13 deletions
diff --git a/gir/gio-2.0.c b/gir/gio-2.0.c index 97a9597b..ecdb2cf2 100644 --- a/gir/gio-2.0.c +++ b/gir/gio-2.0.c @@ -5991,9 +5991,9 @@ * of %G_IO_ERROR_DBUS_ERROR. Note that GDBus clients can still recover * org.project.Foo.Bar.Error.AnotherError using g_dbus_error_get_remote_error(). * - * Note that errors in the %G_DBUS_ERROR error domain is intended only + * Note that the %G_DBUS_ERROR error domain is intended only * for returning errors from a remote message bus process. Errors - * generated locally in-process by e.g. #GDBusConnection is from the + * generated locally in-process by e.g. #GDBusConnection should use the * %G_IO_ERROR domain. */ @@ -11810,6 +11810,18 @@ /** + * _g_io_module_extract_name: + * @filename: filename of a GIOModule + * + * Extract the plugin name from its filename. It removes optional "lib" or + * "libgio" prefix, and removes everything after the first dot. For example: + * "libgiognutls.so" -> "gnutls". + * + * Returns: (transfer full): the module's name + */ + + +/** * _g_io_module_get_default: * @extension_point: the name of an extension point * @envvar: (nullable): the name of an environment variable to @@ -14031,6 +14043,51 @@ /** + * g_application_set_option_context_description: + * @application: the #GApplication + * @description: (nullable): a string to be shown in `--help` output + * after the list of options, or %NULL + * + * Adds a description to the @application option context. + * + * See g_option_context_set_description() for more information. + * + * Since: 2.56 + */ + + +/** + * g_application_set_option_context_parameter_string: + * @application: the #GApplication + * @parameter_string: (nullable): a string which is displayed + * in the first line of `--help` output, after the usage summary `programname [OPTION...]`. + * + * Sets the parameter string to be used by the commandline handling of @application. + * + * This function registers the argument to be passed to g_option_context_new() + * when the internal #GOptionContext of @application is created. + * + * See g_option_context_new() for more information about @parameter_string. + * + * Since: 2.56 + */ + + +/** + * g_application_set_option_context_summary: + * @application: the #GApplication + * @summary: (nullable): a string to be shown in `--help` output + * before the list of options, or %NULL + * + * Adds a summary to the @application option context. + * + * See g_option_context_set_summary() for more information. + * + * Since: 2.56 + */ + + +/** * g_application_set_resource_base_path: * @application: a #GApplication * @resource_path: (nullable): the resource path to use @@ -20928,6 +20985,22 @@ /** + * g_desktop_app_info_get_locale_string: + * @info: a #GDesktopAppInfo + * @key: the key to look up + * + * Looks up a localized string value in the keyfile backing @info + * translated to the current locale. + * + * The @key is looked up in the "Desktop Entry" group. + * + * Returns: (nullable): a newly allocated string, or %NULL if the key + * is not found + * Since: 2.56 + */ + + +/** * g_desktop_app_info_get_nodisplay: * @info: a #GDesktopAppInfo * diff --git a/gir/glib-2.0.c b/gir/glib-2.0.c index 2999e4c3..854cee12 100644 --- a/gir/glib-2.0.c +++ b/gir/glib-2.0.c @@ -11326,7 +11326,8 @@ /** * g_bookmark_file_load_from_data: * @bookmark: an empty #GBookmarkFile struct - * @data: desktop bookmarks loaded in memory + * @data: (array length=length) (element-type guint8): desktop bookmarks + * loaded in memory * @length: the length of @data in bytes * @error: return location for a #GError, or %NULL * @@ -11343,7 +11344,7 @@ * g_bookmark_file_load_from_data_dirs: * @bookmark: a #GBookmarkFile * @file: (type filename): a relative path to a filename to open and parse - * @full_path: (type filename) (nullable): return location for a string + * @full_path: (out) (optional) (type filename): return location for a string * containing the full path of the file, or %NULL * @error: return location for a #GError, or %NULL * @@ -11540,7 +11541,8 @@ * g_bookmark_file_set_groups: * @bookmark: a #GBookmarkFile * @uri: an item's URI - * @groups: (nullable): an array of group names, or %NULL to remove all groups + * @groups: (nullable) (array length=length) (element-type utf8): an array of + * group names, or %NULL to remove all groups * @length: number of group name values in @groups * * Sets a list of group names for the item with URI @uri. Each previously @@ -11661,8 +11663,8 @@ * * This function outputs @bookmark as a string. * - * Returns: a newly allocated string holding - * the contents of the #GBookmarkFile + * Returns: (array length=length) (element-type guint8): + * a newly allocated string holding the contents of the #GBookmarkFile * Since: 2.12 */ @@ -18612,6 +18614,10 @@ * translated in the given @locale if available. If @locale is * %NULL then the current locale is assumed. * + * If @locale is to be non-%NULL, or if the current locale will change over + * the lifetime of the #GKeyFile, it must be loaded with + * %G_KEY_FILE_KEEP_TRANSLATIONS in order to load strings for all locales. + * * If @key cannot be found then %NULL is returned and @error is set * to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the value associated * with @key cannot be interpreted or no suitable translation can @@ -18636,6 +18642,10 @@ * translated in the given @locale if available. If @locale is * %NULL then the current locale is assumed. * + * If @locale is to be non-%NULL, or if the current locale will change over + * the lifetime of the #GKeyFile, it must be loaded with + * %G_KEY_FILE_KEEP_TRANSLATIONS in order to load strings for all locales. + * * If @key cannot be found then %NULL is returned and @error is set * to #G_KEY_FILE_ERROR_KEY_NOT_FOUND. If the values associated * with @key cannot be interpreted or no suitable translations @@ -23601,8 +23611,7 @@ * nothing. * * If *@err is %NULL (ie: an error variable is present but there is no - * error condition) then also do nothing. Whether or not it makes sense - * to take advantage of this feature is up to you. + * error condition) then also do nothing. * * Since: 2.16 */ diff --git a/gir/gobject-2.0.c b/gir/gobject-2.0.c index a825994a..f52cc7ca 100644 --- a/gir/gobject-2.0.c +++ b/gir/gobject-2.0.c @@ -5706,7 +5706,7 @@ /** * g_type_module_add_interface: - * @module: a #GTypeModule + * @module: (nullable): a #GTypeModule * @instance_type: type to which to add the interface. * @interface_type: interface type to add * @interface_info: type information structure @@ -5717,12 +5717,15 @@ * * As long as any instances of the type exist, the type plugin will * not be unloaded. + * + * Since 2.56 if @module is %NULL this will call g_type_add_interface_static() + * instead. This can be used when making a static build of the module. */ /** * g_type_module_register_enum: - * @module: a #GTypeModule + * @module: (nullable): a #GTypeModule * @name: name for the type * @const_static_values: an array of #GEnumValue structs for the * possible enumeration values. The array is @@ -5737,6 +5740,9 @@ * As long as any instances of the type exist, the type plugin will * not be unloaded. * + * Since 2.56 if @module is %NULL this will call g_type_register_static() + * instead. This can be used when making a static build of the module. + * * Since: 2.6 * Returns: the new or existing type ID */ @@ -5744,7 +5750,7 @@ /** * g_type_module_register_flags: - * @module: a #GTypeModule + * @module: (nullable): a #GTypeModule * @name: name for the type * @const_static_values: an array of #GFlagsValue structs for the * possible flags values. The array is @@ -5759,6 +5765,9 @@ * As long as any instances of the type exist, the type plugin will * not be unloaded. * + * Since 2.56 if @module is %NULL this will call g_type_register_static() + * instead. This can be used when making a static build of the module. + * * Since: 2.6 * Returns: the new or existing type ID */ @@ -5766,7 +5775,7 @@ /** * g_type_module_register_type: - * @module: a #GTypeModule + * @module: (nullable): a #GTypeModule * @parent_type: the type for the parent class * @type_name: name for the type * @type_info: type information structure @@ -5784,6 +5793,9 @@ * As long as any instances of the type exist, the type plugin will * not be unloaded. * + * Since 2.56 if @module is %NULL this will call g_type_register_static() + * instead. This can be used when making a static build of the module. + * * Returns: the new or existing type ID */ |