@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gio/dbus-interface-info.d.ts

@@ -6,23 +6,95 @@ import * as GLib from "../glib/index.js";
 export interface DBusInterfaceInfoInit {
     refCount?: number;
 }
+/** Information about a D-Bus interface. */
 export declare class DBusInterfaceInfo {
     ptr: unknown;
     constructor(init?: DBusInterfaceInfoInit);
     protected createPtr(init: DBusInterfaceInfoInit): unknown;
+    /**
+     * Builds a lookup-cache to speed up
+     * g_dbus_interface_info_lookup_method(),
+     * g_dbus_interface_info_lookup_signal() and
+     * g_dbus_interface_info_lookup_property().
+     *
+     * If this has already been called with @info, the existing cache is
+     * used and its use count is increased.
+     *
+     * Note that `info` cannot be modified until
+     * g_dbus_interface_info_cache_release() is called.
+     */
     cacheBuild(): void;
+    /**
+     * Decrements the usage count for the cache for `info` built by
+     * g_dbus_interface_info_cache_build() (if any) and frees the
+     * resources used by the cache if the usage count drops to zero.
+     */
     cacheRelease(): void;
+    /**
+     * Appends an XML representation of `info` (and its children) to @string_builder.
+     *
+     * This function is typically used for generating introspection XML
+     * documents at run-time for handling the
+     * `org.freedesktop.DBus.Introspectable.Introspect`
+     * method.
+     * @param indent - Indentation level.
+     * @param stringBuilder - A #GString to to append XML data to.
+     */
     generateXml(indent: number, stringBuilder: GLib.String): void;
+    /**
+     * Looks up information about a method.
+     *
+     * The cost of this function is O(n) in number of methods unless
+     * g_dbus_interface_info_cache_build() has been used on @info.
+     * @param name - A D-Bus method name (typically in CamelCase)
+     */
     lookupMethod(name: string): DBusMethodInfo | null;
+    /**
+     * Looks up information about a property.
+     *
+     * The cost of this function is O(n) in number of properties unless
+     * g_dbus_interface_info_cache_build() has been used on @info.
+     * @param name - A D-Bus property name (typically in CamelCase).
+     */
     lookupProperty(name: string): DBusPropertyInfo | null;
+    /**
+     * Looks up information about a signal.
+     *
+     * The cost of this function is O(n) in number of signals unless
+     * g_dbus_interface_info_cache_build() has been used on @info.
+     * @param name - A D-Bus signal name (typically in CamelCase)
+     */
     lookupSignal(name: string): DBusSignalInfo | null;
+    /**
+     * If `info` is statically allocated does nothing. Otherwise increases
+     * the reference count.
+     */
     ref(): DBusInterfaceInfo;
+    /**
+     * If `info` is statically allocated, does nothing. Otherwise decreases
+     * the reference count of @info. When its reference count drops to 0,
+     * the memory used is freed.
+     */
     unref(): void;
+    /** The reference count or -1 if statically allocated. */
     get refCount(): number;
     set refCount(value: number);
+    /** The name of the D-Bus interface, e.g. "org.freedesktop.DBus.Properties". */
     get name(): string;
+    /**
+     * A pointer to a %NULL-terminated array of pointers to #GDBusMethodInfo structures or %NULL if there are no methods.
+     */
     get methods(): DBusMethodInfo[];
+    /**
+     * A pointer to a %NULL-terminated array of pointers to #GDBusSignalInfo structures or %NULL if there are no signals.
+     */
     get signals(): DBusSignalInfo[];
+    /**
+     * A pointer to a %NULL-terminated array of pointers to #GDBusPropertyInfo structures or %NULL if there are no properties.
+     */
     get properties(): DBusPropertyInfo[];
+    /**
+     * A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
+     */
     get annotations(): DBusAnnotationInfo[];
 }

package/dist/generated/gio/dbus-interface-info.js

@@ -3,6 +3,7 @@ import { getObject } from "@gtkx/ffi";
 import { DBusMethodInfo } from "./dbus-method-info.js";
 import { DBusPropertyInfo } from "./dbus-property-info.js";
 import { DBusSignalInfo } from "./dbus-signal-info.js";
+/** Information about a D-Bus interface. */
 export class DBusInterfaceInfo {
     ptr;
     constructor(init = {}) {
@@ -14,6 +15,18 @@ export class DBusInterfaceInfo {
             write(ptr, { type: "int", size: 32, unsigned: false }, 0, init.refCount);
         return ptr;
     }
+    /**
+     * Builds a lookup-cache to speed up
+     * g_dbus_interface_info_lookup_method(),
+     * g_dbus_interface_info_lookup_signal() and
+     * g_dbus_interface_info_lookup_property().
+     *
+     * If this has already been called with @info, the existing cache is
+     * used and its use count is increased.
+     *
+     * Note that `info` cannot be modified until
+     * g_dbus_interface_info_cache_release() is called.
+     */
     cacheBuild() {
         call("libgio-2.0.so.0", "g_dbus_interface_info_cache_build", [
             {
@@ -22,6 +35,11 @@ export class DBusInterfaceInfo {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Decrements the usage count for the cache for `info` built by
+     * g_dbus_interface_info_cache_build() (if any) and frees the
+     * resources used by the cache if the usage count drops to zero.
+     */
     cacheRelease() {
         call("libgio-2.0.so.0", "g_dbus_interface_info_cache_release", [
             {
@@ -30,6 +48,16 @@ export class DBusInterfaceInfo {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Appends an XML representation of `info` (and its children) to @string_builder.
+     *
+     * This function is typically used for generating introspection XML
+     * documents at run-time for handling the
+     * `org.freedesktop.DBus.Introspectable.Introspect`
+     * method.
+     * @param indent - Indentation level.
+     * @param stringBuilder - A #GString to to append XML data to.
+     */
     generateXml(indent, stringBuilder) {
         call("libgio-2.0.so.0", "g_dbus_interface_info_generate_xml", [
             {
@@ -51,6 +79,13 @@ export class DBusInterfaceInfo {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Looks up information about a method.
+     *
+     * The cost of this function is O(n) in number of methods unless
+     * g_dbus_interface_info_cache_build() has been used on @info.
+     * @param name - A D-Bus method name (typically in CamelCase)
+     */
     lookupMethod(name) {
         const ptr = call("libgio-2.0.so.0", "g_dbus_interface_info_lookup_method", [
             {
@@ -71,6 +106,13 @@ export class DBusInterfaceInfo {
             return null;
         return getObject(ptr, DBusMethodInfo);
     }
+    /**
+     * Looks up information about a property.
+     *
+     * The cost of this function is O(n) in number of properties unless
+     * g_dbus_interface_info_cache_build() has been used on @info.
+     * @param name - A D-Bus property name (typically in CamelCase).
+     */
     lookupProperty(name) {
         const ptr = call("libgio-2.0.so.0", "g_dbus_interface_info_lookup_property", [
             {
@@ -91,6 +133,13 @@ export class DBusInterfaceInfo {
             return null;
         return getObject(ptr, DBusPropertyInfo);
     }
+    /**
+     * Looks up information about a signal.
+     *
+     * The cost of this function is O(n) in number of signals unless
+     * g_dbus_interface_info_cache_build() has been used on @info.
+     * @param name - A D-Bus signal name (typically in CamelCase)
+     */
     lookupSignal(name) {
         const ptr = call("libgio-2.0.so.0", "g_dbus_interface_info_lookup_signal", [
             {
@@ -111,6 +160,10 @@ export class DBusInterfaceInfo {
             return null;
         return getObject(ptr, DBusSignalInfo);
     }
+    /**
+     * If `info` is statically allocated does nothing. Otherwise increases
+     * the reference count.
+     */
     ref() {
         const ptr = call("libgio-2.0.so.0", "g_dbus_interface_info_ref", [
             {
@@ -125,6 +178,11 @@ export class DBusInterfaceInfo {
         });
         return getObject(ptr, DBusInterfaceInfo);
     }
+    /**
+     * If `info` is statically allocated, does nothing. Otherwise decreases
+     * the reference count of @info. When its reference count drops to 0,
+     * the memory used is freed.
+     */
     unref() {
         call("libgio-2.0.so.0", "g_dbus_interface_info_unref", [
             {
@@ -133,15 +191,20 @@ export class DBusInterfaceInfo {
             },
         ], { type: "undefined" });
     }
+    /** The reference count or -1 if statically allocated. */
     get refCount() {
         return read(this.ptr, { type: "int", size: 32, unsigned: false }, 0);
     }
     set refCount(value) {
         write(this.ptr, { type: "int", size: 32, unsigned: false }, 0, value);
     }
+    /** The name of the D-Bus interface, e.g. "org.freedesktop.DBus.Properties". */
     get name() {
         return read(this.ptr, { type: "string" }, 8);
     }
+    /**
+     * A pointer to a %NULL-terminated array of pointers to #GDBusMethodInfo structures or %NULL if there are no methods.
+     */
     get methods() {
         return read(this.ptr, {
             type: "array",
@@ -152,6 +215,9 @@ export class DBusInterfaceInfo {
             },
         }, 16);
     }
+    /**
+     * A pointer to a %NULL-terminated array of pointers to #GDBusSignalInfo structures or %NULL if there are no signals.
+     */
     get signals() {
         return read(this.ptr, {
             type: "array",
@@ -162,6 +228,9 @@ export class DBusInterfaceInfo {
             },
         }, 24);
     }
+    /**
+     * A pointer to a %NULL-terminated array of pointers to #GDBusPropertyInfo structures or %NULL if there are no properties.
+     */
     get properties() {
         return read(this.ptr, {
             type: "array",
@@ -172,6 +241,9 @@ export class DBusInterfaceInfo {
             },
         }, 32);
     }
+    /**
+     * A pointer to a %NULL-terminated array of pointers to #GDBusAnnotationInfo structures or %NULL if there are no annotations.
+     */
     get annotations() {
         return read(this.ptr, {
             type: "array",

package/dist/generated/gio/dbus-interface-skeleton.d.ts

@@ -8,20 +8,94 @@ import * as GObject from "../gobject/index.js";
 export declare class DBusInterfaceSkeleton extends GObject.GObject {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Exports `interface_` at `object_path` on @connection.
+     *
+     * This can be called multiple times to export the same `interface_` onto multiple connections however the `object_path` provided must be
+     * the same for all connections.
+     *
+     * Use g_dbus_interface_skeleton_unexport() to unexport the object.
+     * @param connection - A #GDBusConnection to export `interface_` on.
+     * @param objectPath - The path to export the interface at.
+     */
     export(connection: DBusConnection, objectPath: string): boolean;
+    /**
+     * If `interface_` has outstanding changes, request for these changes to be
+     * emitted immediately.
+     *
+     * For example, an exported D-Bus interface may queue up property
+     * changes and emit the
+     * `org.freedesktop.DBus.Properties.PropertiesChanged`
+     * signal later (e.g. in an idle handler). This technique is useful
+     * for collapsing multiple property changes into one.
+     */
     flush(): void;
+    /**
+     * Gets the first connection that `interface_` is exported on, if any.
+     */
     getConnection(): DBusConnection | null;
+    /**
+     * Gets a list of the connections that `interface_` is exported on.
+     */
     getConnections(): DBusConnection[];
+    /**
+     * Gets the #GDBusInterfaceSkeletonFlags that describes what the behavior
+     * of @interface_
+     */
     getFlags(): DBusInterfaceSkeletonFlags;
+    /**
+     * Gets D-Bus introspection information for the D-Bus interface
+     * implemented by @interface_.
+     */
     getInfo(): DBusInterfaceInfo;
+    /**
+     * Gets the object path that `interface_` is exported on, if any.
+     */
     getObjectPath(): string | null;
+    /**
+     * Gets all D-Bus properties for @interface_.
+     */
     getProperties(): GLib.Variant;
+    /**
+     * Gets the interface vtable for the D-Bus interface implemented by
+     * @interface_. The returned function pointers should expect `interface_` itself to be passed as @user_data.
+     */
     getVtable(): number;
+    /**
+     * Checks if `interface_` is exported on @connection.
+     * @param connection - A #GDBusConnection.
+     */
     hasConnection(connection: DBusConnection): boolean;
+    /**
+     * Sets flags describing what the behavior of `skeleton` should be.
+     * @param flags - Flags from the #GDBusInterfaceSkeletonFlags enumeration.
+     */
     setFlags(flags: DBusInterfaceSkeletonFlags): void;
+    /**
+     * Stops exporting `interface_` on all connections it is exported on.
+     *
+     * To unexport `interface_` from only a single connection, use
+     * g_dbus_interface_skeleton_unexport_from_connection()
+     */
     unexport(): void;
+    /**
+     * Stops exporting `interface_` on @connection.
+     *
+     * To stop exporting on all connections the interface is exported on,
+     * use g_dbus_interface_skeleton_unexport().
+     * @param connection - A #GDBusConnection.
+     */
     unexportFromConnection(connection: DBusConnection): void;
+    /**
+     * Gets the #GDBusObject that `interface_` belongs to, if any.
+     */
     dupObject(): DBusObject | null;
+    /**
+     * Sets the #GDBusObject for `interface_` to @object.
+     *
+     * Note that `interface_` will hold a weak reference to @object.
+     * @param object - A #GDBusObject or %NULL.
+     */
     setObject(object?: DBusObject | null): void;
     connect(signal: "g-authorize-method", handler: (self: DBusInterfaceSkeleton, invocation: DBusMethodInvocation) => boolean, after?: boolean): number;
     connect(signal: "notify", handler: (self: DBusInterfaceSkeleton, pspec: GObject.ParamSpec) => void, after?: boolean): number;

package/dist/generated/gio/dbus-interface-skeleton.js

@@ -6,6 +6,7 @@ import { DBusObject } from "./dbus-object.js";
 import { DBusMethodInvocation } from "./dbus-method-invocation.js";
 import * as GLib from "../glib/index.js";
 import * as GObject from "../gobject/index.js";
+/** Abstract base class for D-Bus interfaces on the service side. */
 const SIGNAL_META = {
     "g-authorize-method": {
         params: [
@@ -28,6 +29,16 @@ export class DBusInterfaceSkeleton extends GObject.GObject {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Exports `interface_` at `object_path` on @connection.
+     *
+     * This can be called multiple times to export the same `interface_` onto multiple connections however the `object_path` provided must be
+     * the same for all connections.
+     *
+     * Use g_dbus_interface_skeleton_unexport() to unexport the object.
+     * @param connection - A #GDBusConnection to export `interface_` on.
+     * @param objectPath - The path to export the interface at.
+     */
     export(connection, objectPath) {
         const error = { value: null };
         const result = call("libgio-2.0.so.0", "g_dbus_interface_skeleton_export", [
@@ -60,6 +71,16 @@ export class DBusInterfaceSkeleton extends GObject.GObject {
         }
         return result;
     }
+    /**
+     * If `interface_` has outstanding changes, request for these changes to be
+     * emitted immediately.
+     *
+     * For example, an exported D-Bus interface may queue up property
+     * changes and emit the
+     * `org.freedesktop.DBus.Properties.PropertiesChanged`
+     * signal later (e.g. in an idle handler). This technique is useful
+     * for collapsing multiple property changes into one.
+     */
     flush() {
         call("libgio-2.0.so.0", "g_dbus_interface_skeleton_flush", [
             {
@@ -68,6 +89,9 @@ export class DBusInterfaceSkeleton extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the first connection that `interface_` is exported on, if any.
+     */
     getConnection() {
         const ptr = call("libgio-2.0.so.0", "g_dbus_interface_skeleton_get_connection", [
             {
@@ -79,6 +103,9 @@ export class DBusInterfaceSkeleton extends GObject.GObject {
             return null;
         return getObject(ptr, DBusConnection);
     }
+    /**
+     * Gets a list of the connections that `interface_` is exported on.
+     */
     getConnections() {
         const ptrs = call("libgio-2.0.so.0", "g_dbus_interface_skeleton_get_connections", [
             {
@@ -93,6 +120,10 @@ export class DBusInterfaceSkeleton extends GObject.GObject {
         });
         return ptrs.map((ptr) => getObject(ptr, DBusConnection));
     }
+    /**
+     * Gets the #GDBusInterfaceSkeletonFlags that describes what the behavior
+     * of @interface_
+     */
     getFlags() {
         return call("libgio-2.0.so.0", "g_dbus_interface_skeleton_get_flags", [
             {
@@ -101,6 +132,10 @@ export class DBusInterfaceSkeleton extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets D-Bus introspection information for the D-Bus interface
+     * implemented by @interface_.
+     */
     getInfo() {
         const ptr = call("libgio-2.0.so.0", "g_dbus_interface_skeleton_get_info", [
             {
@@ -115,6 +150,9 @@ export class DBusInterfaceSkeleton extends GObject.GObject {
         });
         return getObject(ptr, DBusInterfaceInfo);
     }
+    /**
+     * Gets the object path that `interface_` is exported on, if any.
+     */
     getObjectPath() {
         return call("libgio-2.0.so.0", "g_dbus_interface_skeleton_get_object_path", [
             {
@@ -123,6 +161,9 @@ export class DBusInterfaceSkeleton extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Gets all D-Bus properties for @interface_.
+     */
     getProperties() {
         const ptr = call("libgio-2.0.so.0", "g_dbus_interface_skeleton_get_properties", [
             {
@@ -137,6 +178,10 @@ export class DBusInterfaceSkeleton extends GObject.GObject {
         });
         return getObject(ptr, GLib.Variant);
     }
+    /**
+     * Gets the interface vtable for the D-Bus interface implemented by
+     * @interface_. The returned function pointers should expect `interface_` itself to be passed as @user_data.
+     */
     getVtable() {
         return call("libgio-2.0.so.0", "g_dbus_interface_skeleton_get_vtable", [
             {
@@ -145,6 +190,10 @@ export class DBusInterfaceSkeleton extends GObject.GObject {
             },
         ], { type: "int", size: 64, unsigned: true });
     }
+    /**
+     * Checks if `interface_` is exported on @connection.
+     * @param connection - A #GDBusConnection.
+     */
     hasConnection(connection) {
         return call("libgio-2.0.so.0", "g_dbus_interface_skeleton_has_connection", [
             {
@@ -157,6 +206,10 @@ export class DBusInterfaceSkeleton extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Sets flags describing what the behavior of `skeleton` should be.
+     * @param flags - Flags from the #GDBusInterfaceSkeletonFlags enumeration.
+     */
     setFlags(flags) {
         call("libgio-2.0.so.0", "g_dbus_interface_skeleton_set_flags", [
             {
@@ -169,6 +222,12 @@ export class DBusInterfaceSkeleton extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Stops exporting `interface_` on all connections it is exported on.
+     *
+     * To unexport `interface_` from only a single connection, use
+     * g_dbus_interface_skeleton_unexport_from_connection()
+     */
     unexport() {
         call("libgio-2.0.so.0", "g_dbus_interface_skeleton_unexport", [
             {
@@ -177,6 +236,13 @@ export class DBusInterfaceSkeleton extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Stops exporting `interface_` on @connection.
+     *
+     * To stop exporting on all connections the interface is exported on,
+     * use g_dbus_interface_skeleton_unexport().
+     * @param connection - A #GDBusConnection.
+     */
     unexportFromConnection(connection) {
         call("libgio-2.0.so.0", "g_dbus_interface_skeleton_unexport_from_connection", [
             {
@@ -189,6 +255,9 @@ export class DBusInterfaceSkeleton extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the #GDBusObject that `interface_` belongs to, if any.
+     */
     dupObject() {
         const ptr = call("libgio-2.0.so.0", "g_dbus_interface_dup_object", [
             {
@@ -200,6 +269,12 @@ export class DBusInterfaceSkeleton extends GObject.GObject {
             return null;
         return getObject(ptr, DBusObject);
     }
+    /**
+     * Sets the #GDBusObject for `interface_` to @object.
+     *
+     * Note that `interface_` will hold a weak reference to @object.
+     * @param object - A #GDBusObject or %NULL.
+     */
     setObject(object) {
         call("libgio-2.0.so.0", "g_dbus_interface_set_object", [
             {

package/dist/generated/gio/dbus-interface.d.ts

@@ -1,10 +1,30 @@
 import { DBusInterfaceInfo } from "./dbus-interface-info.js";
 import { DBusObject } from "./dbus-object.js";
+/**
+ * Base type for D-Bus interfaces.
+ *
+ * The `GDBusInterface` type is the base type for D-Bus interfaces both
+ * on the service side (see [class@Gio.DBusInterfaceSkeleton]) and client side
+ * (see [class@Gio.DBusProxy]).
+ */
 export declare class DBusInterface {
     ptr: unknown;
     protected constructor(ptr: unknown);
     static fromPtr(ptr: unknown): DBusInterface;
+    /**
+     * Gets the #GDBusObject that `interface_` belongs to, if any.
+     */
     dupObject(): DBusObject | null;
+    /**
+     * Gets D-Bus introspection information for the D-Bus interface
+     * implemented by @interface_.
+     */
     getInfo(): DBusInterfaceInfo;
+    /**
+     * Sets the #GDBusObject for `interface_` to @object.
+     *
+     * Note that `interface_` will hold a weak reference to @object.
+     * @param object - A #GDBusObject or %NULL.
+     */
     setObject(object?: DBusObject | null): void;
 }

package/dist/generated/gio/dbus-interface.js

@@ -2,6 +2,13 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { DBusInterfaceInfo } from "./dbus-interface-info.js";
 import { DBusObject } from "./dbus-object.js";
+/**
+ * Base type for D-Bus interfaces.
+ *
+ * The `GDBusInterface` type is the base type for D-Bus interfaces both
+ * on the service side (see [class@Gio.DBusInterfaceSkeleton]) and client side
+ * (see [class@Gio.DBusProxy]).
+ */
 export class DBusInterface {
     ptr;
     constructor(ptr) {
@@ -10,6 +17,9 @@ export class DBusInterface {
     static fromPtr(ptr) {
         return new DBusInterface(ptr);
     }
+    /**
+     * Gets the #GDBusObject that `interface_` belongs to, if any.
+     */
     dupObject() {
         const ptr = call("libgio-2.0.so.0", "g_dbus_interface_dup_object", [
             {
@@ -21,6 +31,10 @@ export class DBusInterface {
             return null;
         return getObject(ptr, DBusObject);
     }
+    /**
+     * Gets D-Bus introspection information for the D-Bus interface
+     * implemented by @interface_.
+     */
     getInfo() {
         const ptr = call("libgio-2.0.so.0", "g_dbus_interface_get_info", [
             {
@@ -35,6 +49,12 @@ export class DBusInterface {
         });
         return getObject(ptr, DBusInterfaceInfo);
     }
+    /**
+     * Sets the #GDBusObject for `interface_` to @object.
+     *
+     * Note that `interface_` will hold a weak reference to @object.
+     * @param object - A #GDBusObject or %NULL.
+     */
     setObject(object) {
         call("libgio-2.0.so.0", "g_dbus_interface_set_object", [
             {

package/dist/generated/gio/dbus-menu-model.d.ts

@@ -1,9 +1,27 @@
 import { DBusConnection } from "./dbus-connection.js";
 import * as GObject from "../gobject/index.js";
 import { MenuModel } from "./menu-model.js";
+/**
+ * `GDBusMenuModel` is an implementation of [class@Gio.MenuModel] that can be
+ * used as a proxy for a menu model that is exported over D-Bus with
+ * [method@Gio.DBusConnection.export_menu_model].
+ */
 export declare class DBusMenuModel extends MenuModel {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Obtains a #GDBusMenuModel for the menu model which is exported
+     * at the given `bus_name` and @object_path.
+     *
+     * The thread default main context is taken at the time of this call.
+     * All signals on the menu model (and any linked models) are reported
+     * with respect to this context.  All calls on the returned menu model
+     * (and linked models) must also originate from this same context, with
+     * the thread default main context unchanged.
+     * @param connection - a #GDBusConnection
+     * @param busName - the bus name which exports the menu model
+     * @param objectPath - the object path at which the menu model is exported
+     */
     static get(connection: DBusConnection, objectPath: string, busName?: string | null): DBusMenuModel;
     connect(signal: "notify", handler: (self: DBusMenuModel, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gio/dbus-menu-model.js

@@ -1,6 +1,11 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { MenuModel } from "./menu-model.js";
+/**
+ * `GDBusMenuModel` is an implementation of [class@Gio.MenuModel] that can be
+ * used as a proxy for a menu model that is exported over D-Bus with
+ * [method@Gio.DBusConnection.export_menu_model].
+ */
 export class DBusMenuModel extends MenuModel {
     constructor(...args) {
         super(...args);
@@ -16,6 +21,19 @@ export class DBusMenuModel extends MenuModel {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Obtains a #GDBusMenuModel for the menu model which is exported
+     * at the given `bus_name` and @object_path.
+     *
+     * The thread default main context is taken at the time of this call.
+     * All signals on the menu model (and any linked models) are reported
+     * with respect to this context.  All calls on the returned menu model
+     * (and linked models) must also originate from this same context, with
+     * the thread default main context unchanged.
+     * @param connection - a #GDBusConnection
+     * @param busName - the bus name which exports the menu model
+     * @param objectPath - the object path at which the menu model is exported
+     */
     static get(connection, objectPath, busName) {
         const ptr = call("libgio-2.0.so.0", "g_dbus_menu_model_get", [
             {