@gtkx/ffi 0.1.44 → 0.1.46

package/dist/generated/gio/resource.d.ts

@@ -2,19 +2,297 @@ import { Ref } from "@gtkx/native";
 import { ResourceLookupFlags } from "./enums.js";
 import { InputStream } from "./input-stream.js";
 import * as GLib from "../glib/index.js";
+/**
+ * Applications and libraries often contain binary or textual data that is
+ * really part of the application, rather than user data. For instance
+ * `GtkBuilder` `.ui` files,
+ * splashscreen images, [class@Gio.Menu] markup XML, CSS files, icons, etc.
+ * These are often shipped as files in `$datadir/appname`, or manually
+ * included as literal strings in the code.
+ *
+ * The `GResource` API and the
+ * `glib-compile-resources` program provide a
+ * convenient and efficient alternative to this which has some nice properties.
+ * You maintain the files as normal files, so it’s easy to edit them, but during
+ * the build the files are combined into a binary bundle that is linked into the
+ * executable. This means that loading the resource files are efficient (as they
+ * are already in memory, shared with other instances) and simple (no need to
+ * check for things like I/O errors or locate the files in the filesystem). It
+ * also makes it easier to create relocatable applications.
+ *
+ * Resource files can also be marked as compressed. Such files will be included
+ * in the resource bundle in a compressed form, but will be automatically
+ * uncompressed when the resource is used. This is very useful e.g. for larger
+ * text files that are parsed once (or rarely) and then thrown away.
+ *
+ * Resource files can also be marked to be preprocessed, by setting the value of the
+ * `preprocess` attribute to a comma-separated list of preprocessing options.
+ * The only options currently supported are:
+ *
+ * - `xml-stripblanks` which will use the [`xmllint`](man:xmllint(1)) command
+ * to strip ignorable whitespace from the XML file. For this to work,
+ * the `XMLLINT` environment variable must be set to the full path to
+ * the xmllint executable, or xmllint must be in the `PATH`; otherwise
+ * the preprocessing step is skipped.
+ *
+ * - `to-pixdata` (deprecated since gdk-pixbuf 2.32) which will use the
+ * `gdk-pixbuf-pixdata` command to convert images to the `GdkPixdata`
+ * format, which allows you to create pixbufs directly using the data inside
+ * the resource file, rather than an (uncompressed) copy of it. For this, the
+ * `gdk-pixbuf-pixdata` program must be in the `PATH`, or the
+ * `GDK_PIXBUF_PIXDATA` environment variable must be set to the full path to
+ * the `gdk-pixbuf-pixdata` executable; otherwise the resource compiler will
+ * abort. `to-pixdata` has been deprecated since gdk-pixbuf 2.32, as
+ * `GResource` supports embedding modern image formats just as well. Instead
+ * of using it, embed a PNG or SVG file in your `GResource`.
+ *
+ * - `json-stripblanks` which will use the
+ * [`json-glib-format`](man:json-glib-format(1)) command to strip ignorable
+ * whitespace from the JSON file. For this to work, the `JSON_GLIB_FORMAT`
+ * environment variable must be set to the full path to the
+ * `json-glib-format` executable, or it must be in the `PATH`; otherwise the
+ * preprocessing step is skipped. In addition, at least version 1.6 of
+ * `json-glib-format` is required.
+ *
+ * Resource files will be exported in the `GResource` namespace using the
+ * combination of the given `prefix` and the filename from the `file` element.
+ * The `alias` attribute can be used to alter the filename to expose them at a
+ * different location in the resource namespace. Typically, this is used to
+ * include files from a different source directory without exposing the source
+ * directory in the resource namespace, as in the example below.
+ *
+ * Resource bundles are created by the
+ * `glib-compile-resources` program
+ * which takes an XML file that describes the bundle, and a set of files that
+ * the XML references. These are combined into a binary resource bundle.
+ *
+ * An example resource description:
+ * ```xml
+ * <?xml version="1.0" encoding="UTF-8"?>
+ * <gresources>
+ * <gresource prefix="/org/gtk/Example">
+ * <file>data/splashscreen.png</file>
+ * <file compressed="true">dialog.ui</file>
+ * <file preprocess="xml-stripblanks">menumarkup.xml</file>
+ * <file alias="example.css">data/example.css</file>
+ * </gresource>
+ * </gresources>
+ * ```
+ *
+ * This will create a resource bundle with the following files:
+ * ```
+ * /org/gtk/Example/data/splashscreen.png
+ * /org/gtk/Example/dialog.ui
+ * /org/gtk/Example/menumarkup.xml
+ * /org/gtk/Example/example.css
+ * ```
+ *
+ * Note that all resources in the process share the same namespace, so use
+ * Java-style path prefixes (like in the above example) to avoid conflicts.
+ *
+ * You can then use `glib-compile-resources` to
+ * compile the XML to a binary bundle that you can load with
+ * [func@Gio.Resource.load]. However, it’s more common to use the
+ * `--generate-source` and `--generate-header` arguments to create a source file
+ * and header to link directly into your application.
+ * This will generate `get_resource()`, `register_resource()` and
+ * `unregister_resource()` functions, prefixed by the `--c-name` argument passed
+ * to `glib-compile-resources`. `get_resource()`
+ * returns the generated `GResource` object. The register and unregister
+ * functions register the resource so its files can be accessed using
+ * [func@Gio.resources_lookup_data].
+ *
+ * Once a `GResource` has been created and registered all the data in it can be
+ * accessed globally in the process by using API calls like
+ * [func@Gio.resources_open_stream] to stream the data or
+ * [func@Gio.resources_lookup_data] to get a direct pointer to the data. You can
+ * also use URIs like `resource:///org/gtk/Example/data/splashscreen.png` with
+ * [iface@Gio.File] to access the resource data.
+ *
+ * Some higher-level APIs, such as `GtkApplication`,
+ * will automatically load resources from certain well-known paths in the
+ * resource namespace as a convenience. See the documentation for those APIs
+ * for details.
+ *
+ * There are two forms of the generated source, the default version uses the
+ * compiler support for constructor and destructor functions (where available)
+ * to automatically create and register the `GResource` on startup or library
+ * load time. If you pass `--manual-register`, two functions to
+ * register/unregister the resource are created instead. This requires an
+ * explicit initialization call in your application/library, but it works on all
+ * platforms, even on the minor ones where constructors are not supported.
+ * (Constructor support is available for at least Win32, Mac OS and Linux.)
+ *
+ * Note that resource data can point directly into the data segment of e.g. a
+ * library, so if you are unloading libraries during runtime you need to be very
+ * careful with keeping around pointers to data from a resource, as this goes
+ * away when the library is unloaded. However, in practice this is not generally
+ * a problem, since most resource accesses are for your own resources, and
+ * resource data is often used once, during parsing, and then released.
+ *
+ * # Overlays
+ *
+ * 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 `G_SEARCHPATH_SEPARATOR`-separated list of substitutions
+ * to perform during resource lookups. It is ignored when running in a setuid
+ * process.
+ *
+ * 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.
+ */
 export declare class Resource {
     ptr: unknown;
+    /**
+     * Creates a [struct@Gio.Resource] from a reference to the binary resource bundle.
+     *
+     * This will keep a reference to `data` while the resource lives, so
+     * the data should not be modified or freed.
+     *
+     * If you want to use this resource in the global resource namespace you need
+     * to register it with [func@Gio.resources_register].
+     *
+     * Note: `data` must be backed by memory that is at least pointer aligned.
+     * Otherwise this function will internally create a copy of the memory since
+     * GLib 2.56, or in older versions fail and exit the process.
+     *
+     * If `data` is empty or corrupt, %G_RESOURCE_ERROR_INTERNAL will be returned.
+     * @param data - A [struct@GLib.Bytes]
+     */
     constructor(data: GLib.Bytes);
     constructor(_args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Loads a binary resource bundle and creates a [struct@Gio.Resource]
+     * representation of it, allowing you to query it for data.
+     *
+     * If you want to use this resource in the global resource namespace you need
+     * to register it with [func@Gio.resources_register].
+     *
+     * If `filename` is empty or the data in it is corrupt,
+     * %G_RESOURCE_ERROR_INTERNAL will be returned. If `filename` doesn’t exist, or
+     * there is an error in reading it, an error from [ctor@GLib.MappedFile.new]
+     * will be returned.
+     * @param filename - the path of a filename to load, in the GLib filename encoding
+     */
     static load(filename: string): Resource;
+    /**
+     * Registers the resource with the process-global set of resources.
+     *
+     * Once a resource is registered the files in it can be accessed
+     * with the global resource lookup functions like
+     * [func@Gio.resources_lookup_data].
+     */
     Register(): void;
+    /**
+     * Unregisters the resource from the process-global set of resources.
+     */
     Unregister(): void;
+    /**
+     * 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 [func@GLib.strfreev].
+     *
+     * If `path` is invalid or does not exist in the [struct@Gio.Resource],
+     * %G_RESOURCE_ERROR_NOT_FOUND will be returned.
+     *
+     * `lookup_flags` controls the behaviour of the lookup.
+     * @param path - A path name inside the resource
+     * @param lookupFlags - A [flags@Gio.ResourceLookupFlags]
+     */
     enumerateChildren(path: string, lookupFlags: ResourceLookupFlags): string[];
+    /**
+     * Looks for a file at the specified `path` in the resource and
+     * if found returns information about it.
+     *
+     * `lookup_flags` controls the behaviour of the lookup.
+     *
+     * The only error this can return is %G_RESOURCE_ERROR_NOT_FOUND, if `path` was
+     * not found in @resource.
+     * @param path - A path name inside the resource
+     * @param lookupFlags - A [flags@Gio.ResourceLookupFlags]
+     * @param size - a location to place the length of the contents of the file,
+     * @param flags - a location to place the flags about the file,
+     */
     getInfo(path: string, lookupFlags: ResourceLookupFlags, size?: Ref<number> | null, flags?: Ref<number> | null): boolean;
+    /**
+     * Returns whether the specified `path` in the resource
+     * has children.
+     * @param path - A pathname inside the resource
+     */
     hasChildren(path: string): boolean;
+    /**
+     * Looks for a file at the specified `path` in the resource and
+     * returns a [struct@GLib.Bytes] that lets you directly access the data in
+     * memory.
+     *
+     * The data is always followed by a zero byte, so you
+     * can safely use the data as a C string. However, that byte
+     * is not included in the size of the [struct@GLib.Bytes].
+     *
+     * For uncompressed resource files this is a pointer directly into
+     * the resource bundle, which is typically in some read-only data section
+     * in the program binary. For compressed files, memory is allocated on
+     * the heap and the data is automatically uncompressed.
+     *
+     * `lookup_flags` controls the behaviour of the lookup.
+     *
+     * This can return error %G_RESOURCE_ERROR_NOT_FOUND if `path` was not found in
+     * @resource, or %G_RESOURCE_ERROR_INTERNAL if decompression of a compressed
+     * resource failed.
+     * @param path - A path name inside the resource
+     * @param lookupFlags - A [flags@Gio.ResourceLookupFlags]
+     */
     lookupData(path: string, lookupFlags: ResourceLookupFlags): GLib.Bytes;
+    /**
+     * Looks for a file at the specified `path` in the resource and
+     * returns a [class@Gio.InputStream] that lets you read the data.
+     *
+     * `lookup_flags` controls the behaviour of the lookup.
+     *
+     * The only error this can return is %G_RESOURCE_ERROR_NOT_FOUND, if `path` was
+     * not found in @resource.
+     * @param path - A path name inside the resource
+     * @param lookupFlags - A [flags@Gio.ResourceLookupFlags]
+     */
     openStream(path: string, lookupFlags: ResourceLookupFlags): InputStream;
+    /**
+     * Atomically increments the reference count of `resource` by one.
+     *
+     * This function is threadsafe and may be called from any thread.
+     */
     ref(): Resource;
+    /**
+     * Atomically decrements the reference count of `resource` by one.
+     *
+     * If the reference count drops to 0, all memory allocated by the resource is
+     * released. This function is threadsafe and may be called from any
+     * thread.
+     */
     unref(): void;
 }

package/dist/generated/gio/resource.js

@@ -2,6 +2,169 @@ import { call } from "@gtkx/native";
 import { NativeError, getObject } from "@gtkx/ffi";
 import { InputStream } from "./input-stream.js";
 import * as GLib from "../glib/index.js";
+/**
+ * Applications and libraries often contain binary or textual data that is
+ * really part of the application, rather than user data. For instance
+ * `GtkBuilder` `.ui` files,
+ * splashscreen images, [class@Gio.Menu] markup XML, CSS files, icons, etc.
+ * These are often shipped as files in `$datadir/appname`, or manually
+ * included as literal strings in the code.
+ *
+ * The `GResource` API and the
+ * `glib-compile-resources` program provide a
+ * convenient and efficient alternative to this which has some nice properties.
+ * You maintain the files as normal files, so it’s easy to edit them, but during
+ * the build the files are combined into a binary bundle that is linked into the
+ * executable. This means that loading the resource files are efficient (as they
+ * are already in memory, shared with other instances) and simple (no need to
+ * check for things like I/O errors or locate the files in the filesystem). It
+ * also makes it easier to create relocatable applications.
+ *
+ * Resource files can also be marked as compressed. Such files will be included
+ * in the resource bundle in a compressed form, but will be automatically
+ * uncompressed when the resource is used. This is very useful e.g. for larger
+ * text files that are parsed once (or rarely) and then thrown away.
+ *
+ * Resource files can also be marked to be preprocessed, by setting the value of the
+ * `preprocess` attribute to a comma-separated list of preprocessing options.
+ * The only options currently supported are:
+ *
+ * - `xml-stripblanks` which will use the [`xmllint`](man:xmllint(1)) command
+ * to strip ignorable whitespace from the XML file. For this to work,
+ * the `XMLLINT` environment variable must be set to the full path to
+ * the xmllint executable, or xmllint must be in the `PATH`; otherwise
+ * the preprocessing step is skipped.
+ *
+ * - `to-pixdata` (deprecated since gdk-pixbuf 2.32) which will use the
+ * `gdk-pixbuf-pixdata` command to convert images to the `GdkPixdata`
+ * format, which allows you to create pixbufs directly using the data inside
+ * the resource file, rather than an (uncompressed) copy of it. For this, the
+ * `gdk-pixbuf-pixdata` program must be in the `PATH`, or the
+ * `GDK_PIXBUF_PIXDATA` environment variable must be set to the full path to
+ * the `gdk-pixbuf-pixdata` executable; otherwise the resource compiler will
+ * abort. `to-pixdata` has been deprecated since gdk-pixbuf 2.32, as
+ * `GResource` supports embedding modern image formats just as well. Instead
+ * of using it, embed a PNG or SVG file in your `GResource`.
+ *
+ * - `json-stripblanks` which will use the
+ * [`json-glib-format`](man:json-glib-format(1)) command to strip ignorable
+ * whitespace from the JSON file. For this to work, the `JSON_GLIB_FORMAT`
+ * environment variable must be set to the full path to the
+ * `json-glib-format` executable, or it must be in the `PATH`; otherwise the
+ * preprocessing step is skipped. In addition, at least version 1.6 of
+ * `json-glib-format` is required.
+ *
+ * Resource files will be exported in the `GResource` namespace using the
+ * combination of the given `prefix` and the filename from the `file` element.
+ * The `alias` attribute can be used to alter the filename to expose them at a
+ * different location in the resource namespace. Typically, this is used to
+ * include files from a different source directory without exposing the source
+ * directory in the resource namespace, as in the example below.
+ *
+ * Resource bundles are created by the
+ * `glib-compile-resources` program
+ * which takes an XML file that describes the bundle, and a set of files that
+ * the XML references. These are combined into a binary resource bundle.
+ *
+ * An example resource description:
+ * ```xml
+ * <?xml version="1.0" encoding="UTF-8"?>
+ * <gresources>
+ * <gresource prefix="/org/gtk/Example">
+ * <file>data/splashscreen.png</file>
+ * <file compressed="true">dialog.ui</file>
+ * <file preprocess="xml-stripblanks">menumarkup.xml</file>
+ * <file alias="example.css">data/example.css</file>
+ * </gresource>
+ * </gresources>
+ * ```
+ *
+ * This will create a resource bundle with the following files:
+ * ```
+ * /org/gtk/Example/data/splashscreen.png
+ * /org/gtk/Example/dialog.ui
+ * /org/gtk/Example/menumarkup.xml
+ * /org/gtk/Example/example.css
+ * ```
+ *
+ * Note that all resources in the process share the same namespace, so use
+ * Java-style path prefixes (like in the above example) to avoid conflicts.
+ *
+ * You can then use `glib-compile-resources` to
+ * compile the XML to a binary bundle that you can load with
+ * [func@Gio.Resource.load]. However, it’s more common to use the
+ * `--generate-source` and `--generate-header` arguments to create a source file
+ * and header to link directly into your application.
+ * This will generate `get_resource()`, `register_resource()` and
+ * `unregister_resource()` functions, prefixed by the `--c-name` argument passed
+ * to `glib-compile-resources`. `get_resource()`
+ * returns the generated `GResource` object. The register and unregister
+ * functions register the resource so its files can be accessed using
+ * [func@Gio.resources_lookup_data].
+ *
+ * Once a `GResource` has been created and registered all the data in it can be
+ * accessed globally in the process by using API calls like
+ * [func@Gio.resources_open_stream] to stream the data or
+ * [func@Gio.resources_lookup_data] to get a direct pointer to the data. You can
+ * also use URIs like `resource:///org/gtk/Example/data/splashscreen.png` with
+ * [iface@Gio.File] to access the resource data.
+ *
+ * Some higher-level APIs, such as `GtkApplication`,
+ * will automatically load resources from certain well-known paths in the
+ * resource namespace as a convenience. See the documentation for those APIs
+ * for details.
+ *
+ * There are two forms of the generated source, the default version uses the
+ * compiler support for constructor and destructor functions (where available)
+ * to automatically create and register the `GResource` on startup or library
+ * load time. If you pass `--manual-register`, two functions to
+ * register/unregister the resource are created instead. This requires an
+ * explicit initialization call in your application/library, but it works on all
+ * platforms, even on the minor ones where constructors are not supported.
+ * (Constructor support is available for at least Win32, Mac OS and Linux.)
+ *
+ * Note that resource data can point directly into the data segment of e.g. a
+ * library, so if you are unloading libraries during runtime you need to be very
+ * careful with keeping around pointers to data from a resource, as this goes
+ * away when the library is unloaded. However, in practice this is not generally
+ * a problem, since most resource accesses are for your own resources, and
+ * resource data is often used once, during parsing, and then released.
+ *
+ * # Overlays
+ *
+ * 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 `G_SEARCHPATH_SEPARATOR`-separated list of substitutions
+ * to perform during resource lookups. It is ignored when running in a setuid
+ * process.
+ *
+ * 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.
+ */
 export class Resource {
     ptr;
     constructor(...args) {
@@ -22,6 +185,19 @@ export class Resource {
             },
         ], { type: "boxed", borrowed: true, innerType: "GResource" });
     }
+    /**
+     * Loads a binary resource bundle and creates a [struct@Gio.Resource]
+     * representation of it, allowing you to query it for data.
+     *
+     * If you want to use this resource in the global resource namespace you need
+     * to register it with [func@Gio.resources_register].
+     *
+     * If `filename` is empty or the data in it is corrupt,
+     * %G_RESOURCE_ERROR_INTERNAL will be returned. If `filename` doesn’t exist, or
+     * there is an error in reading it, an error from [ctor@GLib.MappedFile.new]
+     * will be returned.
+     * @param filename - the path of a filename to load, in the GLib filename encoding
+     */
     static load(filename) {
         const error = { value: null };
         const ptr = call("libgio-2.0.so.0", "g_resource_load", [
@@ -51,6 +227,13 @@ export class Resource {
         }
         return getObject(ptr, Resource);
     }
+    /**
+     * Registers the resource with the process-global set of resources.
+     *
+     * Once a resource is registered the files in it can be accessed
+     * with the global resource lookup functions like
+     * [func@Gio.resources_lookup_data].
+     */
     Register() {
         call("libgio-2.0.so.0", "g_resources_register", [
             {
@@ -59,6 +242,9 @@ export class Resource {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Unregisters the resource from the process-global set of resources.
+     */
     Unregister() {
         call("libgio-2.0.so.0", "g_resources_unregister", [
             {
@@ -67,6 +253,19 @@ export class Resource {
             },
         ], { type: "undefined" });
     }
+    /**
+     * 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 [func@GLib.strfreev].
+     *
+     * If `path` is invalid or does not exist in the [struct@Gio.Resource],
+     * %G_RESOURCE_ERROR_NOT_FOUND will be returned.
+     *
+     * `lookup_flags` controls the behaviour of the lookup.
+     * @param path - A path name inside the resource
+     * @param lookupFlags - A [flags@Gio.ResourceLookupFlags]
+     */
     enumerateChildren(path, lookupFlags) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_resource_enumerate_children", [
@@ -99,6 +298,19 @@ export class Resource {
         }
         return result;
     }
+    /**
+     * Looks for a file at the specified `path` in the resource and
+     * if found returns information about it.
+     *
+     * `lookup_flags` controls the behaviour of the lookup.
+     *
+     * The only error this can return is %G_RESOURCE_ERROR_NOT_FOUND, if `path` was
+     * not found in @resource.
+     * @param path - A path name inside the resource
+     * @param lookupFlags - A [flags@Gio.ResourceLookupFlags]
+     * @param size - a location to place the length of the contents of the file,
+     * @param flags - a location to place the flags about the file,
+     */
     getInfo(path, lookupFlags, size, flags) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_resource_get_info", [
@@ -147,6 +359,11 @@ export class Resource {
         }
         return result;
     }
+    /**
+     * Returns whether the specified `path` in the resource
+     * has children.
+     * @param path - A pathname inside the resource
+     */
     hasChildren(path) {
         return call("libgio-2.0.so.0", "g_resource_has_children", [
             {
@@ -159,6 +376,28 @@ export class Resource {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Looks for a file at the specified `path` in the resource and
+     * returns a [struct@GLib.Bytes] that lets you directly access the data in
+     * memory.
+     *
+     * The data is always followed by a zero byte, so you
+     * can safely use the data as a C string. However, that byte
+     * is not included in the size of the [struct@GLib.Bytes].
+     *
+     * For uncompressed resource files this is a pointer directly into
+     * the resource bundle, which is typically in some read-only data section
+     * in the program binary. For compressed files, memory is allocated on
+     * the heap and the data is automatically uncompressed.
+     *
+     * `lookup_flags` controls the behaviour of the lookup.
+     *
+     * This can return error %G_RESOURCE_ERROR_NOT_FOUND if `path` was not found in
+     * @resource, or %G_RESOURCE_ERROR_INTERNAL if decompression of a compressed
+     * resource failed.
+     * @param path - A path name inside the resource
+     * @param lookupFlags - A [flags@Gio.ResourceLookupFlags]
+     */
     lookupData(path, lookupFlags) {
         const error = { value: null };
         const ptr = call("libgio-2.0.so.0", "g_resource_lookup_data", [
@@ -196,6 +435,17 @@ export class Resource {
         }
         return getObject(ptr, GLib.Bytes);
     }
+    /**
+     * Looks for a file at the specified `path` in the resource and
+     * returns a [class@Gio.InputStream] that lets you read the data.
+     *
+     * `lookup_flags` controls the behaviour of the lookup.
+     *
+     * The only error this can return is %G_RESOURCE_ERROR_NOT_FOUND, if `path` was
+     * not found in @resource.
+     * @param path - A path name inside the resource
+     * @param lookupFlags - A [flags@Gio.ResourceLookupFlags]
+     */
     openStream(path, lookupFlags) {
         const error = { value: null };
         const ptr = call("libgio-2.0.so.0", "g_resource_open_stream", [
@@ -228,6 +478,11 @@ export class Resource {
         }
         return getObject(ptr, InputStream);
     }
+    /**
+     * Atomically increments the reference count of `resource` by one.
+     *
+     * This function is threadsafe and may be called from any thread.
+     */
     ref() {
         const ptr = call("libgio-2.0.so.0", "g_resource_ref", [
             {
@@ -242,6 +497,13 @@ export class Resource {
         });
         return getObject(ptr, Resource);
     }
+    /**
+     * Atomically decrements the reference count of `resource` by one.
+     *
+     * If the reference count drops to 0, all memory allocated by the resource is
+     * released. This function is threadsafe and may be called from any
+     * thread.
+     */
     unref() {
         call("libgio-2.0.so.0", "g_resource_unref", [
             {