Update GLib gir files

This commit is contained in:
Vivia Nikolaidou 2020-04-30 14:41:26 +03:00
parent 720c17293b
commit e1b1d4d95a
4 changed files with 23943 additions and 2363 deletions

File diff suppressed because it is too large Load diff

View file

@ -11,8 +11,10 @@ and/or use gtk-doc annotations. -->
<doc xml:space="preserve">The #GModule struct is an opaque data structure to represent a <doc xml:space="preserve">The #GModule struct is an opaque data structure to represent a
[dynamically-loaded module][glib-Dynamic-Loading-of-Modules]. [dynamically-loaded module][glib-Dynamic-Loading-of-Modules].
It should only be accessed via the following functions.</doc> It should only be accessed via the following functions.</doc>
<method name="close" c:identifier="g_module_close"> <method name="close" c:identifier="g_module_close">
<doc xml:space="preserve">Closes a module.</doc> <doc xml:space="preserve">Closes a module.</doc>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success</doc> <doc xml:space="preserve">%TRUE on success</doc>
<type name="gboolean" c:type="gboolean"/> <type name="gboolean" c:type="gboolean"/>
@ -27,6 +29,7 @@ It should only be accessed via the following functions.</doc>
<method name="make_resident" c:identifier="g_module_make_resident"> <method name="make_resident" c:identifier="g_module_make_resident">
<doc xml:space="preserve">Ensures that a module will never be unloaded. <doc xml:space="preserve">Ensures that a module will never be unloaded.
Any future g_module_close() calls on the module will be ignored.</doc> Any future g_module_close() calls on the module will be ignored.</doc>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<type name="none" c:type="void"/> <type name="none" c:type="void"/>
</return-value> </return-value>
@ -41,6 +44,7 @@ Any future g_module_close() calls on the module will be ignored.</doc>
<doc xml:space="preserve">Returns the filename that the module was opened with. <doc xml:space="preserve">Returns the filename that the module was opened with.
If @module refers to the application itself, "main" is returned.</doc> If @module refers to the application itself, "main" is returned.</doc>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<doc xml:space="preserve">the filename of the module</doc> <doc xml:space="preserve">the filename of the module</doc>
<type name="utf8" c:type="const gchar*"/> <type name="utf8" c:type="const gchar*"/>
@ -55,6 +59,7 @@ If @module refers to the application itself, "main" is returned.</doc>
<method name="symbol" c:identifier="g_module_symbol"> <method name="symbol" c:identifier="g_module_symbol">
<doc xml:space="preserve">Gets a symbol pointer from a module, such as one exported <doc xml:space="preserve">Gets a symbol pointer from a module, such as one exported
by #G_MODULE_EXPORT. Note that a valid symbol can be %NULL.</doc> by #G_MODULE_EXPORT. Note that a valid symbol can be %NULL.</doc>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE on success</doc> <doc xml:space="preserve">%TRUE on success</doc>
<type name="gboolean" c:type="gboolean"/> <type name="gboolean" c:type="gboolean"/>
@ -88,6 +93,7 @@ For example, calling g_module_build_path() on a Linux system with a
@directory of `/lib` and a @module_name of "mylibrary" will return @directory of `/lib` and a @module_name of "mylibrary" will return
`/lib/libmylibrary.so`. On a Windows system, using `\Windows` as the `/lib/libmylibrary.so`. On a Windows system, using `\Windows` as the
directory it will return `\Windows\mylibrary.dll`.</doc> directory it will return `\Windows\mylibrary.dll`.</doc>
<return-value transfer-ownership="full"> <return-value transfer-ownership="full">
<doc xml:space="preserve">the complete path of the module, including the standard library <doc xml:space="preserve">the complete path of the module, including the standard library
prefix and suffix. This should be freed when no longer needed</doc> prefix and suffix. This should be freed when no longer needed</doc>
@ -108,6 +114,7 @@ directory it will return `\Windows\mylibrary.dll`.</doc>
</function> </function>
<function name="error" c:identifier="g_module_error"> <function name="error" c:identifier="g_module_error">
<doc xml:space="preserve">Gets a string describing the last module error.</doc> <doc xml:space="preserve">Gets a string describing the last module error.</doc>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<doc xml:space="preserve">a string describing the last module error</doc> <doc xml:space="preserve">a string describing the last module error</doc>
<type name="utf8" c:type="const gchar*"/> <type name="utf8" c:type="const gchar*"/>
@ -122,10 +129,11 @@ If that fails and @file_name has the ".la"-suffix (and is a libtool
archive) it tries to open the corresponding module. If that fails archive) it tries to open the corresponding module. If that fails
and it doesn't have the proper module suffix for the platform and it doesn't have the proper module suffix for the platform
(#G_MODULE_SUFFIX), this suffix will be appended and the corresponding (#G_MODULE_SUFFIX), this suffix will be appended and the corresponding
module will be opended. If that fails and @file_name doesn't have the module will be opened. If that fails and @file_name doesn't have the
".la"-suffix, this suffix is appended and g_module_open() tries to open ".la"-suffix, this suffix is appended and g_module_open() tries to open
the corresponding module. If eventually that fails as well, %NULL is the corresponding module. If eventually that fails as well, %NULL is
returned.</doc> returned.</doc>
<return-value> <return-value>
<doc xml:space="preserve">a #GModule on success, or %NULL on failure</doc> <doc xml:space="preserve">a #GModule on success, or %NULL on failure</doc>
<type name="Module" c:type="GModule*"/> <type name="Module" c:type="GModule*"/>
@ -145,6 +153,7 @@ returned.</doc>
</function> </function>
<function name="supported" c:identifier="g_module_supported"> <function name="supported" c:identifier="g_module_supported">
<doc xml:space="preserve">Checks if modules are supported on the current platform.</doc> <doc xml:space="preserve">Checks if modules are supported on the current platform.</doc>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if modules are supported</doc> <doc xml:space="preserve">%TRUE if modules are supported</doc>
<type name="gboolean" c:type="gboolean"/> <type name="gboolean" c:type="gboolean"/>
@ -157,6 +166,7 @@ If a module contains a function named g_module_check_init() it is called
automatically when the module is loaded. It is passed the #GModule structure automatically when the module is loaded. It is passed the #GModule structure
and should return %NULL on success or a string describing the initialization and should return %NULL on success or a string describing the initialization
error.</doc> error.</doc>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<doc xml:space="preserve">%NULL on success, or a string describing the initialization error</doc> <doc xml:space="preserve">%NULL on success, or a string describing the initialization error</doc>
<type name="utf8" c:type="const gchar*"/> <type name="utf8" c:type="const gchar*"/>
@ -171,6 +181,7 @@ error.</doc>
<bitfield name="ModuleFlags" c:type="GModuleFlags"> <bitfield name="ModuleFlags" c:type="GModuleFlags">
<doc xml:space="preserve">Flags passed to g_module_open(). <doc xml:space="preserve">Flags passed to g_module_open().
Note that these flags are not supported on all platforms.</doc> Note that these flags are not supported on all platforms.</doc>
<member name="lazy" value="1" c:identifier="G_MODULE_BIND_LAZY"> <member name="lazy" value="1" c:identifier="G_MODULE_BIND_LAZY">
<doc xml:space="preserve">specifies that symbols are only resolved when <doc xml:space="preserve">specifies that symbols are only resolved when
needed. The default action is to bind all symbols when the module needed. The default action is to bind all symbols when the module
@ -191,6 +202,7 @@ Note that these flags are not supported on all platforms.</doc>
If a module contains a function named g_module_unload() it is called If a module contains a function named g_module_unload() it is called
automatically when the module is unloaded. automatically when the module is unloaded.
It is passed the #GModule structure.</doc> It is passed the #GModule structure.</doc>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<type name="none" c:type="void"/> <type name="none" c:type="void"/>
</return-value> </return-value>
@ -215,6 +227,7 @@ For example, calling g_module_build_path() on a Linux system with a
@directory of `/lib` and a @module_name of "mylibrary" will return @directory of `/lib` and a @module_name of "mylibrary" will return
`/lib/libmylibrary.so`. On a Windows system, using `\Windows` as the `/lib/libmylibrary.so`. On a Windows system, using `\Windows` as the
directory it will return `\Windows\mylibrary.dll`.</doc> directory it will return `\Windows\mylibrary.dll`.</doc>
<return-value transfer-ownership="full"> <return-value transfer-ownership="full">
<doc xml:space="preserve">the complete path of the module, including the standard library <doc xml:space="preserve">the complete path of the module, including the standard library
prefix and suffix. This should be freed when no longer needed</doc> prefix and suffix. This should be freed when no longer needed</doc>
@ -235,6 +248,7 @@ directory it will return `\Windows\mylibrary.dll`.</doc>
</function> </function>
<function name="module_error" c:identifier="g_module_error" moved-to="Module.error"> <function name="module_error" c:identifier="g_module_error" moved-to="Module.error">
<doc xml:space="preserve">Gets a string describing the last module error.</doc> <doc xml:space="preserve">Gets a string describing the last module error.</doc>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<doc xml:space="preserve">a string describing the last module error</doc> <doc xml:space="preserve">a string describing the last module error</doc>
<type name="utf8" c:type="const gchar*"/> <type name="utf8" c:type="const gchar*"/>
@ -242,6 +256,7 @@ directory it will return `\Windows\mylibrary.dll`.</doc>
</function> </function>
<function name="module_supported" c:identifier="g_module_supported" moved-to="Module.supported"> <function name="module_supported" c:identifier="g_module_supported" moved-to="Module.supported">
<doc xml:space="preserve">Checks if modules are supported on the current platform.</doc> <doc xml:space="preserve">Checks if modules are supported on the current platform.</doc>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if modules are supported</doc> <doc xml:space="preserve">%TRUE if modules are supported</doc>
<type name="gboolean" c:type="gboolean"/> <type name="gboolean" c:type="gboolean"/>

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff