@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gdk/crossing-event.d.ts

@@ -1,9 +1,19 @@
 import { CrossingMode, NotifyType } from "./enums.js";
 import { Event } from "./event.js";
+/** An event caused by a pointing device moving between surfaces. */
 export declare class CrossingEvent extends Event {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Extracts the notify detail from a crossing event.
+     */
     getDetail(): NotifyType;
+    /**
+     * Checks if the `event` surface is the focus surface.
+     */
     getFocus(): boolean;
+    /**
+     * Extracts the crossing mode from a crossing event.
+     */
     getMode(): CrossingMode;
 }

package/dist/generated/gdk/crossing-event.js

@@ -1,5 +1,6 @@
 import { call } from "@gtkx/native";
 import { Event } from "./event.js";
+/** An event caused by a pointing device moving between surfaces. */
 export class CrossingEvent extends Event {
     constructor(...args) {
         super(...args);
@@ -15,6 +16,9 @@ export class CrossingEvent extends Event {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Extracts the notify detail from a crossing event.
+     */
     getDetail() {
         return call("libgtk-4.so.1", "gdk_crossing_event_get_detail", [
             {
@@ -23,6 +27,9 @@ export class CrossingEvent extends Event {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Checks if the `event` surface is the focus surface.
+     */
     getFocus() {
         return call("libgtk-4.so.1", "gdk_crossing_event_get_focus", [
             {
@@ -31,6 +38,9 @@ export class CrossingEvent extends Event {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Extracts the crossing mode from a crossing event.
+     */
     getMode() {
         return call("libgtk-4.so.1", "gdk_crossing_event_get_mode", [
             {

package/dist/generated/gdk/cursor.d.ts

@@ -1,15 +1,154 @@
 import { Texture } from "./texture.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * Used to create and destroy cursors.
+ *
+ * Cursors are immutable objects, so once you created them, there is no way
+ * to modify them later. You should create a new cursor when you want to change
+ * something about it.
+ *
+ * Cursors by themselves are not very interesting: they must be bound to a
+ * window for users to see them. This is done with [method@Gdk.Surface.set_cursor]
+ * or [method@Gdk.Surface.set_device_cursor]. Applications will typically
+ * use higher-level GTK functions such as gtk_widget_set_cursor()
+ * instead.
+ *
+ * Cursors are not bound to a given [class@Gdk.Display], so they can be shared.
+ * However, the appearance of cursors may vary when used on different
+ * platforms.
+ *
+ * ## Named and texture cursors
+ *
+ * There are multiple ways to create cursors. The platform's own cursors
+ * can be created with [ctor@Gdk.Cursor.new_from_name]. That function lists
+ * the commonly available names that are shared with the CSS specification.
+ * Other names may be available, depending on the platform in use. On some
+ * platforms, what images are used for named cursors may be influenced by
+ * the cursor theme.
+ *
+ * Another option to create a cursor is to use [ctor@Gdk.Cursor.new_from_texture]
+ * and provide an image to use for the cursor.
+ *
+ * To ease work with unsupported cursors, a fallback cursor can be provided.
+ * If a [class@Gdk.Surface] cannot use a cursor because of the reasons mentioned
+ * above, it will try the fallback cursor. Fallback cursors can themselves have
+ * fallback cursors again, so it is possible to provide a chain of progressively
+ * easier to support cursors. If none of the provided cursors can be supported,
+ * the default cursor will be the ultimate fallback.
+ */
 export declare class Cursor extends GObject.GObject {
+    /**
+     * Creates a new callback-based cursor object.
+     *
+     * Cursors of this kind produce textures for the cursor
+     * image on demand, when the `callback` is called.
+     * @param callback - the `GdkCursorGetTextureCallback`
+     * @param data - data to pass to @callback
+     * @param destroy - destroy notify for @data
+     * @param fallback - the `GdkCursor` to fall back to when
+     */
     constructor(callback: (...args: unknown[]) => unknown, destroy: () => void, data?: number | null, fallback?: Cursor | null);
     constructor(...args: unknown[]);
+    /**
+     * Creates a new cursor by looking up `name` in the current cursor
+     * theme.
+     *
+     * A recommended set of cursor names that will work across different
+     * platforms can be found in the CSS specification:
+     *
+     * | | | |
+     * | --- | --- | --- |
+     * |                               | "none"          | No cursor |
+     * |        | "default"       | The default cursor |
+     * |           | "help"          | Help is available |
+     * |        | "pointer"       | Indicates a link or interactive element |
+     * |   |"context-menu"   | A context menu is available |
+     * |       | "progress"      | Progress indicator |
+     * |           | "wait"          | Busy cursor |
+     * |           | "cell"          | Cell(s) may be selected |
+     * |      | "crosshair"     | Simple crosshair |
+     * |           | "text"          | Text may be selected |
+     * |  | "vertical-text" | Vertical text may be selected |
+     * |          | "alias"         | DND: Something will be linked |
+     * |           | "copy"          | DND: Something will be copied |
+     * |           | "move"          | DND: Something will be moved |
+     * |        | "dnd-ask"       | DND: User can choose action to be carried out |
+     * |        | "no-drop"       | DND: Can't drop here |
+     * |    | "not-allowed"   | DND: Action will not be carried out |
+     * |           | "grab"          | DND: Something can be grabbed |
+     * |       | "grabbing"      | DND: Something is being grabbed |
+     * |       | "n-resize"      | Resizing: Move north border |
+     * |       | "e-resize"      | Resizing: Move east border |
+     * |       | "s-resize"      | Resizing: Move south border |
+     * |       | "w-resize"      | Resizing: Move west border |
+     * |      | "ne-resize"     | Resizing: Move north-east corner |
+     * |      | "nw-resize"     | Resizing: Move north-west corner |
+     * |      | "sw-resize"     | Resizing: Move south-west corner |
+     * |      | "se-resize"     | Resizing: Move south-east corner |
+     * |     | "col-resize"    | Resizing: Move an item or border horizontally |
+     * |     | "row-resize"    | Resizing: Move an item or border vertically |
+     * |      | "ew-resize"     | Moving: Something can be moved horizontally |
+     * |      | "ns-resize"     | Moving: Something can be moved vertically |
+     * |    | "nesw-resize"   | Moving: Something can be moved diagonally, north-east to south-west |
+     * |    | "nwse-resize"   | Moving: something can be moved diagonally, north-west to south-east |
+     * |     | "all-resize"    | Moving: Something can be moved in any direction |
+     * |     | "all-scroll"    | Can scroll in any direction |
+     * |        | "zoom-in"       | Zoom in |
+     * |       | "zoom-out"      | Zoom out |
+     * @param name - the name of the cursor
+     * @param fallback - %NULL or the `GdkCursor` to fall back to when
+     */
     static newFromName(name: string, fallback?: Cursor | null): Cursor;
+    /**
+     * Creates a new cursor from a `GdkTexture`.
+     * @param texture - the texture providing the pixel data
+     * @param hotspotX - the horizontal offset of the “hotspot” of the cursor
+     * @param hotspotY - the vertical offset of the “hotspot” of the cursor
+     * @param fallback - the `GdkCursor` to fall back to when
+     */
     static newFromTexture(texture: Texture, hotspotX: number, hotspotY: number, fallback?: Cursor | null): Cursor;
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Returns the fallback for this @cursor.
+     *
+     * The fallback will be used if this cursor is not available on a given
+     * `GdkDisplay`. For named cursors, this can happen when using nonstandard
+     * names or when using an incomplete cursor theme. For textured cursors,
+     * this can happen when the texture is too large or when the `GdkDisplay`
+     * it is used on does not support textured cursors.
+     */
     getFallback(): Cursor | null;
+    /**
+     * Returns the horizontal offset of the hotspot.
+     *
+     * The hotspot indicates the pixel that will be directly above the cursor.
+     *
+     * Note that named cursors may have a nonzero hotspot, but this function
+     * will only return the hotspot position for cursors created with
+     * [ctor@Gdk.Cursor.new_from_texture].
+     */
     getHotspotX(): number;
+    /**
+     * Returns the vertical offset of the hotspot.
+     *
+     * The hotspot indicates the pixel that will be directly above the cursor.
+     *
+     * Note that named cursors may have a nonzero hotspot, but this function
+     * will only return the hotspot position for cursors created with
+     * [ctor@Gdk.Cursor.new_from_texture].
+     */
     getHotspotY(): number;
+    /**
+     * Returns the name of the cursor.
+     *
+     * If the cursor is not a named cursor, %NULL will be returned.
+     */
     getName(): string | null;
+    /**
+     * Returns the texture for the cursor.
+     *
+     * If the cursor is a named cursor, %NULL will be returned.
+     */
     getTexture(): Texture | null;
     connect(signal: "notify", handler: (self: Cursor, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gdk/cursor.js

@@ -2,10 +2,95 @@ import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import { Texture } from "./texture.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * Used to create and destroy cursors.
+ *
+ * Cursors are immutable objects, so once you created them, there is no way
+ * to modify them later. You should create a new cursor when you want to change
+ * something about it.
+ *
+ * Cursors by themselves are not very interesting: they must be bound to a
+ * window for users to see them. This is done with [method@Gdk.Surface.set_cursor]
+ * or [method@Gdk.Surface.set_device_cursor]. Applications will typically
+ * use higher-level GTK functions such as gtk_widget_set_cursor()
+ * instead.
+ *
+ * Cursors are not bound to a given [class@Gdk.Display], so they can be shared.
+ * However, the appearance of cursors may vary when used on different
+ * platforms.
+ *
+ * ## Named and texture cursors
+ *
+ * There are multiple ways to create cursors. The platform's own cursors
+ * can be created with [ctor@Gdk.Cursor.new_from_name]. That function lists
+ * the commonly available names that are shared with the CSS specification.
+ * Other names may be available, depending on the platform in use. On some
+ * platforms, what images are used for named cursors may be influenced by
+ * the cursor theme.
+ *
+ * Another option to create a cursor is to use [ctor@Gdk.Cursor.new_from_texture]
+ * and provide an image to use for the cursor.
+ *
+ * To ease work with unsupported cursors, a fallback cursor can be provided.
+ * If a [class@Gdk.Surface] cannot use a cursor because of the reasons mentioned
+ * above, it will try the fallback cursor. Fallback cursors can themselves have
+ * fallback cursors again, so it is possible to provide a chain of progressively
+ * easier to support cursors. If none of the provided cursors can be supported,
+ * the default cursor will be the ultimate fallback.
+ */
 export class Cursor extends GObject.GObject {
     constructor(...args) {
         super(...args);
     }
+    /**
+     * Creates a new cursor by looking up `name` in the current cursor
+     * theme.
+     *
+     * A recommended set of cursor names that will work across different
+     * platforms can be found in the CSS specification:
+     *
+     * | | | |
+     * | --- | --- | --- |
+     * |                               | "none"          | No cursor |
+     * |        | "default"       | The default cursor |
+     * |           | "help"          | Help is available |
+     * |        | "pointer"       | Indicates a link or interactive element |
+     * |   |"context-menu"   | A context menu is available |
+     * |       | "progress"      | Progress indicator |
+     * |           | "wait"          | Busy cursor |
+     * |           | "cell"          | Cell(s) may be selected |
+     * |      | "crosshair"     | Simple crosshair |
+     * |           | "text"          | Text may be selected |
+     * |  | "vertical-text" | Vertical text may be selected |
+     * |          | "alias"         | DND: Something will be linked |
+     * |           | "copy"          | DND: Something will be copied |
+     * |           | "move"          | DND: Something will be moved |
+     * |        | "dnd-ask"       | DND: User can choose action to be carried out |
+     * |        | "no-drop"       | DND: Can't drop here |
+     * |    | "not-allowed"   | DND: Action will not be carried out |
+     * |           | "grab"          | DND: Something can be grabbed |
+     * |       | "grabbing"      | DND: Something is being grabbed |
+     * |       | "n-resize"      | Resizing: Move north border |
+     * |       | "e-resize"      | Resizing: Move east border |
+     * |       | "s-resize"      | Resizing: Move south border |
+     * |       | "w-resize"      | Resizing: Move west border |
+     * |      | "ne-resize"     | Resizing: Move north-east corner |
+     * |      | "nw-resize"     | Resizing: Move north-west corner |
+     * |      | "sw-resize"     | Resizing: Move south-west corner |
+     * |      | "se-resize"     | Resizing: Move south-east corner |
+     * |     | "col-resize"    | Resizing: Move an item or border horizontally |
+     * |     | "row-resize"    | Resizing: Move an item or border vertically |
+     * |      | "ew-resize"     | Moving: Something can be moved horizontally |
+     * |      | "ns-resize"     | Moving: Something can be moved vertically |
+     * |    | "nesw-resize"   | Moving: Something can be moved diagonally, north-east to south-west |
+     * |    | "nwse-resize"   | Moving: something can be moved diagonally, north-west to south-east |
+     * |     | "all-resize"    | Moving: Something can be moved in any direction |
+     * |     | "all-scroll"    | Can scroll in any direction |
+     * |        | "zoom-in"       | Zoom in |
+     * |       | "zoom-out"      | Zoom out |
+     * @param name - the name of the cursor
+     * @param fallback - %NULL or the `GdkCursor` to fall back to when
+     */
     static newFromName(name, fallback) {
         const ptr = call("libgtk-4.so.1", "gdk_cursor_new_from_name", [
             {
@@ -20,6 +105,13 @@ export class Cursor extends GObject.GObject {
         ], { type: "gobject", borrowed: false });
         return getObject(ptr, Cursor);
     }
+    /**
+     * Creates a new cursor from a `GdkTexture`.
+     * @param texture - the texture providing the pixel data
+     * @param hotspotX - the horizontal offset of the “hotspot” of the cursor
+     * @param hotspotY - the vertical offset of the “hotspot” of the cursor
+     * @param fallback - the `GdkCursor` to fall back to when
+     */
     static newFromTexture(texture, hotspotX, hotspotY, fallback) {
         const ptr = call("libgtk-4.so.1", "gdk_cursor_new_from_texture", [
             {
@@ -65,6 +157,15 @@ export class Cursor extends GObject.GObject {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Returns the fallback for this @cursor.
+     *
+     * The fallback will be used if this cursor is not available on a given
+     * `GdkDisplay`. For named cursors, this can happen when using nonstandard
+     * names or when using an incomplete cursor theme. For textured cursors,
+     * this can happen when the texture is too large or when the `GdkDisplay`
+     * it is used on does not support textured cursors.
+     */
     getFallback() {
         const ptr = call("libgtk-4.so.1", "gdk_cursor_get_fallback", [
             {
@@ -76,6 +177,15 @@ export class Cursor extends GObject.GObject {
             return null;
         return getObject(ptr, Cursor);
     }
+    /**
+     * Returns the horizontal offset of the hotspot.
+     *
+     * The hotspot indicates the pixel that will be directly above the cursor.
+     *
+     * Note that named cursors may have a nonzero hotspot, but this function
+     * will only return the hotspot position for cursors created with
+     * [ctor@Gdk.Cursor.new_from_texture].
+     */
     getHotspotX() {
         return call("libgtk-4.so.1", "gdk_cursor_get_hotspot_x", [
             {
@@ -84,6 +194,15 @@ export class Cursor extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the vertical offset of the hotspot.
+     *
+     * The hotspot indicates the pixel that will be directly above the cursor.
+     *
+     * Note that named cursors may have a nonzero hotspot, but this function
+     * will only return the hotspot position for cursors created with
+     * [ctor@Gdk.Cursor.new_from_texture].
+     */
     getHotspotY() {
         return call("libgtk-4.so.1", "gdk_cursor_get_hotspot_y", [
             {
@@ -92,6 +211,11 @@ export class Cursor extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the name of the cursor.
+     *
+     * If the cursor is not a named cursor, %NULL will be returned.
+     */
     getName() {
         return call("libgtk-4.so.1", "gdk_cursor_get_name", [
             {
@@ -100,6 +224,11 @@ export class Cursor extends GObject.GObject {
             },
         ], { type: "string", borrowed: true });
     }
+    /**
+     * Returns the texture for the cursor.
+     *
+     * If the cursor is a named cursor, %NULL will be returned.
+     */
     getTexture() {
         const ptr = call("libgtk-4.so.1", "gdk_cursor_get_texture", [
             {

package/dist/generated/gdk/delete-event.d.ts

@@ -1,4 +1,5 @@
 import { Event } from "./event.js";
+/** An event related to closing a top-level surface. */
 export declare class DeleteEvent extends Event {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;

package/dist/generated/gdk/delete-event.js

@@ -1,5 +1,6 @@
 import { call } from "@gtkx/native";
 import { Event } from "./event.js";
+/** An event related to closing a top-level surface. */
 export class DeleteEvent extends Event {
     constructor(...args) {
         super(...args);

package/dist/generated/gdk/device-pad.d.ts

@@ -1,10 +1,50 @@
 import { DevicePadFeature } from "./enums.js";
+/**
+ * An interface for tablet pad devices.
+ *
+ * It allows querying the features provided by the pad device.
+ *
+ * Tablet pads may contain one or more groups, each containing a subset
+ * of the buttons/rings/strips available. [method@Gdk.DevicePad.get_n_groups]
+ * can be used to obtain the number of groups, [method@Gdk.DevicePad.get_n_features]
+ * and [method@Gdk.DevicePad.get_feature_group] can be combined to find out
+ * the number of buttons/rings/strips the device has, and how are they grouped.
+ *
+ * Each of those groups have different modes, which may be used to map each
+ * individual pad feature to multiple actions. Only one mode is effective
+ * (current) for each given group, different groups may have different
+ * current modes. The number of available modes in a group can be found
+ * out through [method@Gdk.DevicePad.get_group_n_modes], and the current mode
+ * for a given group will be notified through events of type `GDK_PAD_GROUP_MODE`.
+ */
 export declare class DevicePad {
     ptr: unknown;
     protected constructor(ptr: unknown);
     static fromPtr(ptr: unknown): DevicePad;
+    /**
+     * Returns the group the given `feature` and `idx` belong to.
+     *
+     * f the feature or index do not exist in @pad, -1 is returned.
+     * @param feature - the feature type to get the group from
+     * @param featureIdx - the index of the feature to get the group from
+     */
     getFeatureGroup(feature: DevicePadFeature, featureIdx: number): number;
+    /**
+     * Returns the number of modes that `group` may have.
+     * @param groupIdx - group to get the number of available modes from
+     */
     getGroupNModes(groupIdx: number): number;
+    /**
+     * Returns the number of features a tablet pad has.
+     * @param feature - a pad feature
+     */
     getNFeatures(feature: DevicePadFeature): number;
+    /**
+     * Returns the number of groups this pad device has.
+     *
+     * Pads have at least one group. A pad group is a subcollection of
+     * buttons/strip/rings that is affected collectively by a same
+     * current mode.
+     */
     getNGroups(): number;
 }

package/dist/generated/gdk/device-pad.js

@@ -1,4 +1,22 @@
 import { call } from "@gtkx/native";
+/**
+ * An interface for tablet pad devices.
+ *
+ * It allows querying the features provided by the pad device.
+ *
+ * Tablet pads may contain one or more groups, each containing a subset
+ * of the buttons/rings/strips available. [method@Gdk.DevicePad.get_n_groups]
+ * can be used to obtain the number of groups, [method@Gdk.DevicePad.get_n_features]
+ * and [method@Gdk.DevicePad.get_feature_group] can be combined to find out
+ * the number of buttons/rings/strips the device has, and how are they grouped.
+ *
+ * Each of those groups have different modes, which may be used to map each
+ * individual pad feature to multiple actions. Only one mode is effective
+ * (current) for each given group, different groups may have different
+ * current modes. The number of available modes in a group can be found
+ * out through [method@Gdk.DevicePad.get_group_n_modes], and the current mode
+ * for a given group will be notified through events of type `GDK_PAD_GROUP_MODE`.
+ */
 export class DevicePad {
     ptr;
     constructor(ptr) {
@@ -7,6 +25,13 @@ export class DevicePad {
     static fromPtr(ptr) {
         return new DevicePad(ptr);
     }
+    /**
+     * Returns the group the given `feature` and `idx` belong to.
+     *
+     * f the feature or index do not exist in @pad, -1 is returned.
+     * @param feature - the feature type to get the group from
+     * @param featureIdx - the index of the feature to get the group from
+     */
     getFeatureGroup(feature, featureIdx) {
         return call("libgtk-4.so.1", "gdk_device_pad_get_feature_group", [
             {
@@ -23,6 +48,10 @@ export class DevicePad {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the number of modes that `group` may have.
+     * @param groupIdx - group to get the number of available modes from
+     */
     getGroupNModes(groupIdx) {
         return call("libgtk-4.so.1", "gdk_device_pad_get_group_n_modes", [
             {
@@ -35,6 +64,10 @@ export class DevicePad {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the number of features a tablet pad has.
+     * @param feature - a pad feature
+     */
     getNFeatures(feature) {
         return call("libgtk-4.so.1", "gdk_device_pad_get_n_features", [
             {
@@ -47,6 +80,13 @@ export class DevicePad {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the number of groups this pad device has.
+     *
+     * Pads have at least one group. A pad group is a subcollection of
+     * buttons/strip/rings that is affected collectively by a same
+     * current mode.
+     */
     getNGroups() {
         return call("libgtk-4.so.1", "gdk_device_pad_get_n_groups", [
             {

package/dist/generated/gdk/device-tool.d.ts

@@ -1,11 +1,37 @@
 import { AxisFlags, DeviceToolType } from "./enums.js";
 import * as GObject from "../gobject/index.js";
+/** A physical tool associated to a `GdkDevice`. */
 export declare class DeviceTool extends GObject.GObject {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Gets the axes of the tool.
+     */
     getAxes(): AxisFlags;
+    /**
+     * Gets the hardware ID of this tool, or 0 if it's not known.
+     *
+     * When non-zero, the identifier is unique for the given tool model,
+     * meaning that two identical tools will share the same @hardware_id,
+     * but will have different serial numbers (see
+     * [method@Gdk.DeviceTool.get_serial]).
+     *
+     * This is a more concrete (and device specific) method to identify
+     * a `GdkDeviceTool` than [method@Gdk.DeviceTool.get_tool_type],
+     * as a tablet may support multiple devices with the same
+     * `GdkDeviceToolType`, but different hardware identifiers.
+     */
     getHardwareId(): number;
+    /**
+     * Gets the serial number of this tool.
+     *
+     * This value can be used to identify a physical tool
+     * (eg. a tablet pen) across program executions.
+     */
     getSerial(): number;
+    /**
+     * Gets the `GdkDeviceToolType` of the tool.
+     */
     getToolType(): DeviceToolType;
     connect(signal: "notify", handler: (self: DeviceTool, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gdk/device-tool.js

@@ -1,6 +1,7 @@
 import { call } from "@gtkx/native";
 import { getObject } from "@gtkx/ffi";
 import * as GObject from "../gobject/index.js";
+/** A physical tool associated to a `GdkDevice`. */
 export class DeviceTool extends GObject.GObject {
     constructor(...args) {
         super(...args);
@@ -16,6 +17,9 @@ export class DeviceTool extends GObject.GObject {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * Gets the axes of the tool.
+     */
     getAxes() {
         return call("libgtk-4.so.1", "gdk_device_tool_get_axes", [
             {
@@ -24,6 +28,19 @@ export class DeviceTool extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the hardware ID of this tool, or 0 if it's not known.
+     *
+     * When non-zero, the identifier is unique for the given tool model,
+     * meaning that two identical tools will share the same @hardware_id,
+     * but will have different serial numbers (see
+     * [method@Gdk.DeviceTool.get_serial]).
+     *
+     * This is a more concrete (and device specific) method to identify
+     * a `GdkDeviceTool` than [method@Gdk.DeviceTool.get_tool_type],
+     * as a tablet may support multiple devices with the same
+     * `GdkDeviceToolType`, but different hardware identifiers.
+     */
     getHardwareId() {
         return call("libgtk-4.so.1", "gdk_device_tool_get_hardware_id", [
             {
@@ -32,6 +49,12 @@ export class DeviceTool extends GObject.GObject {
             },
         ], { type: "int", size: 64, unsigned: true });
     }
+    /**
+     * Gets the serial number of this tool.
+     *
+     * This value can be used to identify a physical tool
+     * (eg. a tablet pen) across program executions.
+     */
     getSerial() {
         return call("libgtk-4.so.1", "gdk_device_tool_get_serial", [
             {
@@ -40,6 +63,9 @@ export class DeviceTool extends GObject.GObject {
             },
         ], { type: "int", size: 64, unsigned: true });
     }
+    /**
+     * Gets the `GdkDeviceToolType` of the tool.
+     */
     getToolType() {
         return call("libgtk-4.so.1", "gdk_device_tool_get_tool_type", [
             {