@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gio/unix-socket-address.d.ts

@@ -1,14 +1,104 @@
 import { UnixSocketAddressType } from "./enums.js";
 import { SocketAddress } from "./socket-address.js";
+/**
+ * Support for UNIX-domain (also known as local) sockets, corresponding to
+ * `struct sockaddr_un`.
+ *
+ * UNIX domain sockets are generally visible in the filesystem.
+ * However, some systems support abstract socket names which are not
+ * visible in the filesystem and not affected by the filesystem
+ * permissions, visibility, etc. Currently this is only supported
+ * under Linux. If you attempt to use abstract sockets on other
+ * systems, function calls may return `G_IO_ERROR_NOT_SUPPORTED`
+ * errors. You can use [func@Gio.UnixSocketAddress.abstract_names_supported]
+ * to see if abstract names are supported.
+ *
+ * Since GLib 2.72, `GUnixSocketAddress` is available on all platforms. It
+ * requires underlying system support (such as Windows 10 with `AF_UNIX`) at
+ * run time.
+ *
+ * Before GLib 2.72, `<gio/gunixsocketaddress.h>` belonged to the UNIX-specific
+ * GIO interfaces, thus you had to use the `gio-unix-2.0.pc` pkg-config file
+ * when using it. This is no longer necessary since GLib 2.72.
+ */
 export declare class UnixSocketAddress extends SocketAddress {
+    /**
+     * Creates a new #GUnixSocketAddress for @path.
+     *
+     * To create abstract socket addresses, on systems that support that,
+     * use g_unix_socket_address_new_abstract().
+     * @param path - the socket path
+     */
     constructor(path: string);
     constructor(...args: unknown[]);
+    /**
+     * Creates a new %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED
+     * #GUnixSocketAddress for @path.
+     * @param path - the abstract name
+     * @param pathLen - the length of @path, or -1
+     */
     static socketAddressNewAbstract(path: number[], pathLen: number): UnixSocketAddress;
+    /**
+     * Creates a new #GUnixSocketAddress of type `type` with name @path.
+     *
+     * If `type` is %G_UNIX_SOCKET_ADDRESS_PATH, this is equivalent to
+     * calling g_unix_socket_address_new().
+     *
+     * If `type` is %G_UNIX_SOCKET_ADDRESS_ANONYMOUS, `path` and `path_len` will be
+     * ignored.
+     *
+     * If `path_type` is %G_UNIX_SOCKET_ADDRESS_ABSTRACT, then `path_len` bytes of `path` will be copied to the socket's path, and only those
+     * bytes will be considered part of the name. (If `path_len` is -1,
+     * then `path` is assumed to be NUL-terminated.) For example, if `path` was "test", then calling g_socket_address_get_native_size() on the
+     * returned socket would return 7 (2 bytes of overhead, 1 byte for the
+     * abstract-socket indicator byte, and 4 bytes for the name "test").
+     *
+     * If `path_type` is %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED, then
+     * `path_len` bytes of `path` will be copied to the socket's path, the
+     * rest of the path will be padded with 0 bytes, and the entire
+     * zero-padded buffer will be considered the name. (As above, if
+     * `path_len` is -1, then `path` is assumed to be NUL-terminated.) In
+     * this case, g_socket_address_get_native_size() will always return
+     * the full size of a `struct sockaddr_un`, although
+     * g_unix_socket_address_get_path_len() will still return just the
+     * length of @path.
+     *
+     * %G_UNIX_SOCKET_ADDRESS_ABSTRACT is preferred over
+     * %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED for new programs. Of course,
+     * when connecting to a server created by another process, you must
+     * use the appropriate type corresponding to how that process created
+     * its listening socket.
+     * @param path - the name
+     * @param pathLen - the length of @path, or -1
+     * @param type - a #GUnixSocketAddressType
+     */
     static socketAddressNewWithType(path: number[], pathLen: number, type: UnixSocketAddressType): UnixSocketAddress;
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Checks if abstract UNIX domain socket names are supported.
+     */
     static abstractNamesSupported(): boolean;
+    /**
+     * Gets @address's type.
+     */
     getAddressType(): UnixSocketAddressType;
+    /**
+     * Tests if `address` is abstract.
+     */
     getIsAbstract(): boolean;
+    /**
+     * Gets @address's path, or for abstract sockets the "name".
+     *
+     * Guaranteed to be zero-terminated, but an abstract socket
+     * may contain embedded zeros, and thus you should use
+     * g_unix_socket_address_get_path_len() to get the true length
+     * of this string.
+     */
     getPath(): string;
+    /**
+     * Gets the length of @address's path.
+     *
+     * For details, see g_unix_socket_address_get_path().
+     */
     getPathLen(): number;
 }

package/dist/generated/gio/unix-socket-address.js

@@ -1,10 +1,37 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { SocketAddress } from "./socket-address.js";
+/**
+ * Support for UNIX-domain (also known as local) sockets, corresponding to
+ * `struct sockaddr_un`.
+ *
+ * UNIX domain sockets are generally visible in the filesystem.
+ * However, some systems support abstract socket names which are not
+ * visible in the filesystem and not affected by the filesystem
+ * permissions, visibility, etc. Currently this is only supported
+ * under Linux. If you attempt to use abstract sockets on other
+ * systems, function calls may return `G_IO_ERROR_NOT_SUPPORTED`
+ * errors. You can use [func@Gio.UnixSocketAddress.abstract_names_supported]
+ * to see if abstract names are supported.
+ *
+ * Since GLib 2.72, `GUnixSocketAddress` is available on all platforms. It
+ * requires underlying system support (such as Windows 10 with `AF_UNIX`) at
+ * run time.
+ *
+ * Before GLib 2.72, `<gio/gunixsocketaddress.h>` belonged to the UNIX-specific
+ * GIO interfaces, thus you had to use the `gio-unix-2.0.pc` pkg-config file
+ * when using it. This is no longer necessary since GLib 2.72.
+ */
 export class UnixSocketAddress extends SocketAddress {
     constructor(...args) {
         super(...args);
     }
+    /**
+     * Creates a new %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED
+     * #GUnixSocketAddress for @path.
+     * @param path - the abstract name
+     * @param pathLen - the length of @path, or -1
+     */
     static socketAddressNewAbstract(path, pathLen) {
         const ptr = call("libgio-2.0.so.0", "g_unix_socket_address_new_abstract", [
             {
@@ -21,6 +48,40 @@ export class UnixSocketAddress extends SocketAddress {
         ], { type: "gobject", borrowed: false });
         return getObject(ptr, UnixSocketAddress);
     }
+    /**
+     * Creates a new #GUnixSocketAddress of type `type` with name @path.
+     *
+     * If `type` is %G_UNIX_SOCKET_ADDRESS_PATH, this is equivalent to
+     * calling g_unix_socket_address_new().
+     *
+     * If `type` is %G_UNIX_SOCKET_ADDRESS_ANONYMOUS, `path` and `path_len` will be
+     * ignored.
+     *
+     * If `path_type` is %G_UNIX_SOCKET_ADDRESS_ABSTRACT, then `path_len` bytes of `path` will be copied to the socket's path, and only those
+     * bytes will be considered part of the name. (If `path_len` is -1,
+     * then `path` is assumed to be NUL-terminated.) For example, if `path` was "test", then calling g_socket_address_get_native_size() on the
+     * returned socket would return 7 (2 bytes of overhead, 1 byte for the
+     * abstract-socket indicator byte, and 4 bytes for the name "test").
+     *
+     * If `path_type` is %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED, then
+     * `path_len` bytes of `path` will be copied to the socket's path, the
+     * rest of the path will be padded with 0 bytes, and the entire
+     * zero-padded buffer will be considered the name. (As above, if
+     * `path_len` is -1, then `path` is assumed to be NUL-terminated.) In
+     * this case, g_socket_address_get_native_size() will always return
+     * the full size of a `struct sockaddr_un`, although
+     * g_unix_socket_address_get_path_len() will still return just the
+     * length of @path.
+     *
+     * %G_UNIX_SOCKET_ADDRESS_ABSTRACT is preferred over
+     * %G_UNIX_SOCKET_ADDRESS_ABSTRACT_PADDED for new programs. Of course,
+     * when connecting to a server created by another process, you must
+     * use the appropriate type corresponding to how that process created
+     * its listening socket.
+     * @param path - the name
+     * @param pathLen - the length of @path, or -1
+     * @param type - a #GUnixSocketAddressType
+     */
     static socketAddressNewWithType(path, pathLen, type) {
         const ptr = call("libgio-2.0.so.0", "g_unix_socket_address_new_with_type", [
             {
@@ -50,9 +111,15 @@ export class UnixSocketAddress extends SocketAddress {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Checks if abstract UNIX domain socket names are supported.
+     */
     static abstractNamesSupported() {
         return call("libgio-2.0.so.0", "g_unix_socket_address_abstract_names_supported", [], { type: "boolean" });
     }
+    /**
+     * Gets @address's type.
+     */
     getAddressType() {
         return call("libgio-2.0.so.0", "g_unix_socket_address_get_address_type", [
             {
@@ -61,6 +128,9 @@ export class UnixSocketAddress extends SocketAddress {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Tests if `address` is abstract.
+     */
     getIsAbstract() {
         return call("libgio-2.0.so.0", "g_unix_socket_address_get_is_abstract", [
             {
@@ -69,6 +139,14 @@ export class UnixSocketAddress extends SocketAddress {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Gets @address's path, or for abstract sockets the "name".
+     *
+     * Guaranteed to be zero-terminated, but an abstract socket
+     * may contain embedded zeros, and thus you should use
+     * g_unix_socket_address_get_path_len() to get the true length
+     * of this string.
+     */
     getPath() {
         return call("libgio-2.0.so.0", "g_unix_socket_address_get_path", [
             {
@@ -77,6 +155,11 @@ export class UnixSocketAddress extends SocketAddress {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Gets the length of @address's path.
+     *
+     * For details, see g_unix_socket_address_get_path().
+     */
     getPathLen() {
         return call("libgio-2.0.so.0", "g_unix_socket_address_get_path_len", [
             {

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

@@ -1,16 +1,81 @@
 import { File } from "./file.js";
 import * as GObject from "../gobject/index.js";
+/** Entry point for using GIO functionality. */
 export declare class Vfs extends GObject.GObject {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Gets the default #GVfs for the system.
+     */
     static getDefault(): Vfs;
+    /**
+     * Gets the local #GVfs for the system.
+     */
     static getLocal(): Vfs;
+    /**
+     * Gets a #GFile for @path.
+     * @param path - a string containing a VFS path.
+     */
     getFileForPath(path: string): File;
+    /**
+     * Gets a #GFile for @uri.
+     *
+     * This operation never fails, but the returned object
+     * might not support any I/O operation if the URI
+     * is malformed or if the URI scheme is not supported.
+     * @param uri - a string containing a URI
+     */
     getFileForUri(uri: string): File;
+    /**
+     * Gets a list of URI schemes supported by @vfs.
+     */
     getSupportedUriSchemes(): string[];
+    /**
+     * Checks if the VFS is active.
+     */
     isActive(): boolean;
+    /**
+     * This operation never fails, but the returned object might
+     * not support any I/O operations if the `parse_name` cannot
+     * be parsed by the #GVfs module.
+     * @param parseName - a string to be parsed by the VFS module.
+     */
     parseName(parseName: string): File;
+    /**
+     * Registers `uri_func` and `parse_name_func` as the #GFile URI and parse name
+     * lookup functions for URIs with a scheme matching @scheme.
+     * Note that `scheme` is registered only within the running application, as
+     * opposed to desktop-wide as it happens with GVfs backends.
+     *
+     * When a #GFile is requested with an URI containing `scheme` (e.g. through
+     * g_file_new_for_uri()), `uri_func` will be called to allow a custom
+     * constructor. The implementation of `uri_func` should not be blocking, and
+     * must not call g_vfs_register_uri_scheme() or g_vfs_unregister_uri_scheme().
+     *
+     * When g_file_parse_name() is called with a parse name obtained from such file,
+     * `parse_name_func` will be called to allow the #GFile to be created again. In
+     * that case, it's responsibility of `parse_name_func` to make sure the parse
+     * name matches what the custom #GFile implementation returned when
+     * g_file_get_parse_name() was previously called. The implementation of
+     * `parse_name_func` should not be blocking, and must not call
+     * g_vfs_register_uri_scheme() or g_vfs_unregister_uri_scheme().
+     *
+     * It's an error to call this function twice with the same scheme. To unregister
+     * a custom URI scheme, use g_vfs_unregister_uri_scheme().
+     * @param scheme - an URI scheme, e.g. "http"
+     * @param uriFunc - a #GVfsFileLookupFunc
+     * @param uriData - custom data passed to be passed to @uri_func, or %NULL
+     * @param uriDestroy - function to be called when unregistering the
+     * @param parseNameFunc - a #GVfsFileLookupFunc
+     * @param parseNameData - custom data passed to be passed to
+     * @param parseNameDestroy - function to be called when unregistering the
+     */
     registerUriScheme(scheme: string, uriFunc?: (...args: unknown[]) => unknown | null, uriData?: number | null, uriDestroy?: () => void | null, parseNameFunc?: (...args: unknown[]) => unknown | null, parseNameData?: number | null, parseNameDestroy?: () => void | null): boolean;
+    /**
+     * Unregisters the URI handler for `scheme` previously registered with
+     * g_vfs_register_uri_scheme().
+     * @param scheme - an URI scheme, e.g. "http"
+     */
     unregisterUriScheme(scheme: string): boolean;
     connect(signal: "notify", handler: (self: Vfs, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gio/vfs.js

@@ -2,6 +2,7 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { File } from "./file.js";
 import * as GObject from "../gobject/index.js";
+/** Entry point for using GIO functionality. */
 export class Vfs extends GObject.GObject {
     constructor(...args) {
         super(...args);
@@ -17,6 +18,9 @@ export class Vfs extends GObject.GObject {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Gets the default #GVfs for the system.
+     */
     static getDefault() {
         const ptr = call("libgio-2.0.so.0", "g_vfs_get_default", [], {
             type: "gobject",
@@ -24,6 +28,9 @@ export class Vfs extends GObject.GObject {
         });
         return getObject(ptr, Vfs);
     }
+    /**
+     * Gets the local #GVfs for the system.
+     */
     static getLocal() {
         const ptr = call("libgio-2.0.so.0", "g_vfs_get_local", [], {
             type: "gobject",
@@ -31,6 +38,10 @@ export class Vfs extends GObject.GObject {
         });
         return getObject(ptr, Vfs);
     }
+    /**
+     * Gets a #GFile for @path.
+     * @param path - a string containing a VFS path.
+     */
     getFileForPath(path) {
         const ptr = call("libgio-2.0.so.0", "g_vfs_get_file_for_path", [
             {
@@ -44,6 +55,14 @@ export class Vfs extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, File);
     }
+    /**
+     * Gets a #GFile for @uri.
+     *
+     * This operation never fails, but the returned object
+     * might not support any I/O operation if the URI
+     * is malformed or if the URI scheme is not supported.
+     * @param uri - a string containing a URI
+     */
     getFileForUri(uri) {
         const ptr = call("libgio-2.0.so.0", "g_vfs_get_file_for_uri", [
             {
@@ -57,6 +76,9 @@ export class Vfs extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, File);
     }
+    /**
+     * Gets a list of URI schemes supported by @vfs.
+     */
     getSupportedUriSchemes() {
         return call("libgio-2.0.so.0", "g_vfs_get_supported_uri_schemes", [
             {
@@ -65,6 +87,9 @@ export class Vfs extends GObject.GObject {
             },
         ], { type: "array", itemType: { type: "string" } });
     }
+    /**
+     * Checks if the VFS is active.
+     */
     isActive() {
         return call("libgio-2.0.so.0", "g_vfs_is_active", [
             {
@@ -73,6 +98,12 @@ export class Vfs extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * This operation never fails, but the returned object might
+     * not support any I/O operations if the `parse_name` cannot
+     * be parsed by the #GVfs module.
+     * @param parseName - a string to be parsed by the VFS module.
+     */
     parseName(parseName) {
         const ptr = call("libgio-2.0.so.0", "g_vfs_parse_name", [
             {
@@ -86,6 +117,35 @@ export class Vfs extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, File);
     }
+    /**
+     * Registers `uri_func` and `parse_name_func` as the #GFile URI and parse name
+     * lookup functions for URIs with a scheme matching @scheme.
+     * Note that `scheme` is registered only within the running application, as
+     * opposed to desktop-wide as it happens with GVfs backends.
+     *
+     * When a #GFile is requested with an URI containing `scheme` (e.g. through
+     * g_file_new_for_uri()), `uri_func` will be called to allow a custom
+     * constructor. The implementation of `uri_func` should not be blocking, and
+     * must not call g_vfs_register_uri_scheme() or g_vfs_unregister_uri_scheme().
+     *
+     * When g_file_parse_name() is called with a parse name obtained from such file,
+     * `parse_name_func` will be called to allow the #GFile to be created again. In
+     * that case, it's responsibility of `parse_name_func` to make sure the parse
+     * name matches what the custom #GFile implementation returned when
+     * g_file_get_parse_name() was previously called. The implementation of
+     * `parse_name_func` should not be blocking, and must not call
+     * g_vfs_register_uri_scheme() or g_vfs_unregister_uri_scheme().
+     *
+     * It's an error to call this function twice with the same scheme. To unregister
+     * a custom URI scheme, use g_vfs_unregister_uri_scheme().
+     * @param scheme - an URI scheme, e.g. "http"
+     * @param uriFunc - a #GVfsFileLookupFunc
+     * @param uriData - custom data passed to be passed to @uri_func, or %NULL
+     * @param uriDestroy - function to be called when unregistering the
+     * @param parseNameFunc - a #GVfsFileLookupFunc
+     * @param parseNameData - custom data passed to be passed to
+     * @param parseNameDestroy - function to be called when unregistering the
+     */
     registerUriScheme(scheme, uriFunc, uriData, uriDestroy, parseNameFunc, parseNameData, parseNameDestroy) {
         return call("libgio-2.0.so.0", "g_vfs_register_uri_scheme", [
             {
@@ -128,6 +188,11 @@ export class Vfs extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Unregisters the URI handler for `scheme` previously registered with
+     * g_vfs_register_uri_scheme().
+     * @param scheme - an URI scheme, e.g. "http"
+     */
     unregisterUriScheme(scheme) {
         return call("libgio-2.0.so.0", "g_vfs_unregister_uri_scheme", [
             {

package/dist/generated/gio/volume-monitor.d.ts

@@ -5,12 +5,72 @@ import * as GObject from "../gobject/index.js";
 export declare class VolumeMonitor extends GObject.GObject {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * This function should be called by any #GVolumeMonitor
+     * implementation when a new #GMount object is created that is not
+     * associated with a #GVolume object. It must be called just before
+     * emitting the `mount_added` signal.
+     *
+     * If the return value is not %NULL, the caller must associate the
+     * returned #GVolume object with the #GMount. This involves returning
+     * it in its g_mount_get_volume() implementation. The caller must
+     * also listen for the "removed" signal on the returned object
+     * and give up its reference when handling that signal
+     *
+     * Similarly, if implementing g_volume_monitor_adopt_orphan_mount(),
+     * the implementor must take a reference to `mount` and return it in
+     * its g_volume_get_mount() implemented. Also, the implementor must
+     * listen for the "unmounted" signal on `mount` and give up its
+     * reference upon handling that signal.
+     *
+     * There are two main use cases for this function.
+     *
+     * One is when implementing a user space file system driver that reads
+     * blocks of a block device that is already represented by the native
+     * volume monitor (for example a CD Audio file system driver). Such
+     * a driver will generate its own #GMount object that needs to be
+     * associated with the #GVolume object that represents the volume.
+     *
+     * The other is for implementing a #GVolumeMonitor whose sole purpose
+     * is to return #GVolume objects representing entries in the users
+     * "favorite servers" list or similar.
+     * @param mount - a #GMount object to find a parent for
+     */
     static adoptOrphanMount(mount: Mount): Volume;
+    /**
+     * Gets the volume monitor used by gio.
+     */
     static get(): VolumeMonitor;
+    /**
+     * Gets a list of drives connected to the system.
+     *
+     * The returned list should be freed with g_list_free(), after
+     * its elements have been unreffed with g_object_unref().
+     */
     getConnectedDrives(): Drive[];
+    /**
+     * Finds a #GMount object by its UUID (see g_mount_get_uuid())
+     * @param uuid - the UUID to look for
+     */
     getMountForUuid(uuid: string): Mount | null;
+    /**
+     * Gets a list of the mounts on the system.
+     *
+     * The returned list should be freed with g_list_free(), after
+     * its elements have been unreffed with g_object_unref().
+     */
     getMounts(): Mount[];
+    /**
+     * Finds a #GVolume object by its UUID (see g_volume_get_uuid())
+     * @param uuid - the UUID to look for
+     */
     getVolumeForUuid(uuid: string): Volume | null;
+    /**
+     * Gets a list of the volumes on the system.
+     *
+     * The returned list should be freed with g_list_free(), after
+     * its elements have been unreffed with g_object_unref().
+     */
     getVolumes(): Volume[];
     connect(signal: "drive-changed", handler: (self: VolumeMonitor, drive: Drive) => void, after?: boolean): number;
     connect(signal: "drive-connected", handler: (self: VolumeMonitor, drive: Drive) => void, after?: boolean): number;

package/dist/generated/gio/volume-monitor.js

@@ -4,6 +4,19 @@ import { Drive } from "./drive.js";
 import { Mount } from "./mount.js";
 import { Volume } from "./volume.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * `GVolumeMonitor` is for listing the user interesting devices and volumes
+ * on the computer. In other words, what a file selector or file manager
+ * would show in a sidebar.
+ *
+ * `GVolumeMonitor` is not
+ * thread-default-context aware (see
+ * [method@GLib.MainContext.push_thread_default]), and so should not be used
+ * other than from the main thread, with no thread-default-context active.
+ *
+ * In order to receive updates about volumes and mounts monitored through GVFS,
+ * a main loop must be running.
+ */
 const SIGNAL_META = {
     "drive-changed": {
         params: [{ type: { type: "gobject", borrowed: true } }],
@@ -69,6 +82,37 @@ export class VolumeMonitor extends GObject.GObject {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * This function should be called by any #GVolumeMonitor
+     * implementation when a new #GMount object is created that is not
+     * associated with a #GVolume object. It must be called just before
+     * emitting the `mount_added` signal.
+     *
+     * If the return value is not %NULL, the caller must associate the
+     * returned #GVolume object with the #GMount. This involves returning
+     * it in its g_mount_get_volume() implementation. The caller must
+     * also listen for the "removed" signal on the returned object
+     * and give up its reference when handling that signal
+     *
+     * Similarly, if implementing g_volume_monitor_adopt_orphan_mount(),
+     * the implementor must take a reference to `mount` and return it in
+     * its g_volume_get_mount() implemented. Also, the implementor must
+     * listen for the "unmounted" signal on `mount` and give up its
+     * reference upon handling that signal.
+     *
+     * There are two main use cases for this function.
+     *
+     * One is when implementing a user space file system driver that reads
+     * blocks of a block device that is already represented by the native
+     * volume monitor (for example a CD Audio file system driver). Such
+     * a driver will generate its own #GMount object that needs to be
+     * associated with the #GVolume object that represents the volume.
+     *
+     * The other is for implementing a #GVolumeMonitor whose sole purpose
+     * is to return #GVolume objects representing entries in the users
+     * "favorite servers" list or similar.
+     * @param mount - a #GMount object to find a parent for
+     */
     static adoptOrphanMount(mount) {
         return call("libgio-2.0.so.0", "g_volume_monitor_adopt_orphan_mount", [
             {
@@ -77,6 +121,9 @@ export class VolumeMonitor extends GObject.GObject {
             },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Gets the volume monitor used by gio.
+     */
     static get() {
         const ptr = call("libgio-2.0.so.0", "g_volume_monitor_get", [], {
             type: "gobject",
@@ -84,6 +131,12 @@ export class VolumeMonitor extends GObject.GObject {
         });
         return getObject(ptr, VolumeMonitor);
     }
+    /**
+     * Gets a list of drives connected to the system.
+     *
+     * The returned list should be freed with g_list_free(), after
+     * its elements have been unreffed with g_object_unref().
+     */
     getConnectedDrives() {
         const ptrs = call("libgio-2.0.so.0", "g_volume_monitor_get_connected_drives", [
             {
@@ -98,6 +151,10 @@ export class VolumeMonitor extends GObject.GObject {
         });
         return ptrs.map((ptr) => getObject(ptr, Drive));
     }
+    /**
+     * Finds a #GMount object by its UUID (see g_mount_get_uuid())
+     * @param uuid - the UUID to look for
+     */
     getMountForUuid(uuid) {
         const ptr = call("libgio-2.0.so.0", "g_volume_monitor_get_mount_for_uuid", [
             {
@@ -113,6 +170,12 @@ export class VolumeMonitor extends GObject.GObject {
             return null;
         return getObject(ptr, Mount);
     }
+    /**
+     * Gets a list of the mounts on the system.
+     *
+     * The returned list should be freed with g_list_free(), after
+     * its elements have been unreffed with g_object_unref().
+     */
     getMounts() {
         const ptrs = call("libgio-2.0.so.0", "g_volume_monitor_get_mounts", [
             {
@@ -127,6 +190,10 @@ export class VolumeMonitor extends GObject.GObject {
         });
         return ptrs.map((ptr) => getObject(ptr, Mount));
     }
+    /**
+     * Finds a #GVolume object by its UUID (see g_volume_get_uuid())
+     * @param uuid - the UUID to look for
+     */
     getVolumeForUuid(uuid) {
         const ptr = call("libgio-2.0.so.0", "g_volume_monitor_get_volume_for_uuid", [
             {
@@ -142,6 +209,12 @@ export class VolumeMonitor extends GObject.GObject {
             return null;
         return getObject(ptr, Volume);
     }
+    /**
+     * Gets a list of the volumes on the system.
+     *
+     * The returned list should be freed with g_list_free(), after
+     * its elements have been unreffed with g_object_unref().
+     */
     getVolumes() {
         const ptrs = call("libgio-2.0.so.0", "g_volume_monitor_get_volumes", [
             {