@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/gtksource/completion-snippets.js

@@ -3,6 +3,13 @@ import { NativeError, getObject } from "@gtkx/ffi";
 import * as GLib from "../glib/index.js";
 import * as GObject from "../gobject/index.js";
 import * as Gio from "../gio/index.js";
+/**
+ * A [iface@CompletionProvider] for the completion of snippets.
+ *
+ * The `GtkSourceCompletionSnippets` is an example of an implementation of
+ * the [iface@CompletionProvider] interface. The proposals are snippets
+ * registered with the [class@SnippetManager].
+ */
 export class CompletionSnippets extends GObject.GObject {
     constructor(...args) {
         super(...args);
@@ -10,6 +17,18 @@ export class CompletionSnippets extends GObject.GObject {
     createPtr(_args) {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_snippets_new", [], { type: "gobject", borrowed: false });
     }
+    /**
+     * This function requests `proposal` to be activated by the
+     * #GtkSourceCompletionProvider.
+     *
+     * What the provider does to activate the proposal is specific to that
+     * provider. Many providers may choose to insert a #GtkSourceSnippet with
+     * edit points the user may cycle through.
+     *
+     * See also: [class@Snippet], [class@SnippetChunk], [method@View.push_snippet]
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     */
     activate(context, proposal) {
         call("libgtksourceview-5.so.0", "gtk_source_completion_provider_activate", [
             {
@@ -26,6 +45,19 @@ export class CompletionSnippets extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * This function requests that the #GtkSourceCompletionProvider prepares
+     * `cell` to display the contents of @proposal.
+     *
+     * Based on `cells` column type, you may want to display different information.
+     *
+     * This allows for columns of information among completion proposals
+     * resulting in better alignment of similar content (icons, return types,
+     * method names, and parameter lists).
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     * @param cell - a #GtkSourceCompletionCell
+     */
     display(context, proposal, cell) {
         call("libgtksourceview-5.so.0", "gtk_source_completion_provider_display", [
             {
@@ -46,6 +78,16 @@ export class CompletionSnippets extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * This function should return the priority of `self` in @context.
+     *
+     * The priority is used to sort groups of completion proposals by
+     * provider so that higher priority providers results are shown
+     * above lower priority providers.
+     *
+     * Higher value indicates higher priority.
+     * @param context - a #GtkSourceCompletionContext
+     */
     getPriority(context) {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_provider_get_priority", [
             {
@@ -58,6 +100,12 @@ export class CompletionSnippets extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the title of the completion provider, if any.
+     *
+     * Currently, titles are not displayed in the completion results, but may be
+     * at some point in the future when non-%NULL.
+     */
     getTitle() {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_provider_get_title", [
             {
@@ -66,6 +114,19 @@ export class CompletionSnippets extends GObject.GObject {
             },
         ], { type: "string" });
     }
+    /**
+     * This function is used to determine if a character inserted into the text
+     * editor should cause a new completion request to be triggered.
+     *
+     * An example would be period '.' which might indicate that the user wants
+     * to complete method or field names of an object.
+     *
+     * This method will only trigger when text is inserted into the #GtkTextBuffer
+     * while the completion list is visible and a proposal is selected. Incremental
+     * key-presses (like shift, control, or alt) are not triggerable.
+     * @param iter - a #GtkTextIter
+     * @param ch - a #gunichar of the character inserted
+     */
     isTrigger(iter, ch) {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_provider_is_trigger", [
             {
@@ -87,6 +148,18 @@ export class CompletionSnippets extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * This function is used to determine if a key typed by the user should
+     * activate `proposal` (resulting in committing the text to the editor).
+     *
+     * This is useful when using languages where convention may lead to less
+     * typing by the user. One example may be the use of "." or "-" to expand
+     * a field access in the C programming language.
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     * @param keyval - a keyval such as [const@Gdk.KEY_period]
+     * @param state - a #GdkModifierType or 0
+     */
     keyActivates(context, proposal, keyval, state) {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_provider_key_activates", [
             {
@@ -111,6 +184,15 @@ export class CompletionSnippets extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Providers should return a list of alternates to `proposal` or %NULL if
+     * there are no alternates available.
+     *
+     * This can be used by the completion view to allow the user to move laterally
+     * through similar proposals, such as overrides of methods by the same name.
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     */
     listAlternates(context, proposal) {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_completion_provider_list_alternates", [
             {
@@ -135,6 +217,10 @@ export class CompletionSnippets extends GObject.GObject {
             return null;
         return getObject(ptr, GLib.PtrArray);
     }
+    /**
+     * Completes an asynchronous operation to populate a completion provider.
+     * @param result - a #GAsyncResult provided to callback
+     */
     populateFinish(result) {
         const error = { value: null };
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_completion_provider_populate_finish", [
@@ -163,6 +249,16 @@ export class CompletionSnippets extends GObject.GObject {
         }
         return getObject(ptr, Gio.ListModel);
     }
+    /**
+     * This function can be used to filter results previously provided to
+     * the [class@CompletionContext] by the #GtkSourceCompletionProvider.
+     *
+     * This can happen as the user types additional text onto the word so
+     * that previously matched items may be removed from the list instead of
+     * generating new [iface@Gio.ListModel] of results.
+     * @param context - a #GtkSourceCompletionContext
+     * @param model - a #GListModel
+     */
     refilter(context, model) {
         call("libgtksourceview-5.so.0", "gtk_source_completion_provider_refilter", [
             {

package/dist/generated/gtksource/completion-words.d.ts

@@ -6,20 +6,127 @@ import * as GObject from "../gobject/index.js";
 import * as Gdk from "../gdk/index.js";
 import * as Gio from "../gio/index.js";
 import * as Gtk from "../gtk/index.js";
+/**
+ * A [iface@CompletionProvider] for the completion of words.
+ *
+ * The `GtkSourceCompletionWords` is an example of an implementation of
+ * the [iface@CompletionProvider] interface. The proposals are words
+ * appearing in the registered [class@Gtk.TextBuffer]s.
+ */
 export declare class CompletionWords extends GObject.GObject {
+    /**
+     * @param title - The title for the provider, or %NULL.
+     */
     constructor(title?: string | null);
     constructor(...args: unknown[]);
     protected createPtr(args: unknown[]): unknown;
+    /**
+     * Registers `buffer` in the `words` provider.
+     * @param buffer - a #GtkTextBuffer
+     */
     register(buffer: Gtk.TextBuffer): void;
+    /**
+     * Unregisters `buffer` from the `words` provider.
+     * @param buffer - a #GtkTextBuffer
+     */
     unregister(buffer: Gtk.TextBuffer): void;
+    /**
+     * This function requests `proposal` to be activated by the
+     * #GtkSourceCompletionProvider.
+     *
+     * What the provider does to activate the proposal is specific to that
+     * provider. Many providers may choose to insert a #GtkSourceSnippet with
+     * edit points the user may cycle through.
+     *
+     * See also: [class@Snippet], [class@SnippetChunk], [method@View.push_snippet]
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     */
     activate(context: CompletionContext, proposal: CompletionProposal): void;
+    /**
+     * This function requests that the #GtkSourceCompletionProvider prepares
+     * `cell` to display the contents of @proposal.
+     *
+     * Based on `cells` column type, you may want to display different information.
+     *
+     * This allows for columns of information among completion proposals
+     * resulting in better alignment of similar content (icons, return types,
+     * method names, and parameter lists).
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     * @param cell - a #GtkSourceCompletionCell
+     */
     display(context: CompletionContext, proposal: CompletionProposal, cell: CompletionCell): void;
+    /**
+     * This function should return the priority of `self` in @context.
+     *
+     * The priority is used to sort groups of completion proposals by
+     * provider so that higher priority providers results are shown
+     * above lower priority providers.
+     *
+     * Higher value indicates higher priority.
+     * @param context - a #GtkSourceCompletionContext
+     */
     getPriority(context: CompletionContext): number;
+    /**
+     * Gets the title of the completion provider, if any.
+     *
+     * Currently, titles are not displayed in the completion results, but may be
+     * at some point in the future when non-%NULL.
+     */
     getTitle(): string | null;
+    /**
+     * This function is used to determine if a character inserted into the text
+     * editor should cause a new completion request to be triggered.
+     *
+     * An example would be period '.' which might indicate that the user wants
+     * to complete method or field names of an object.
+     *
+     * This method will only trigger when text is inserted into the #GtkTextBuffer
+     * while the completion list is visible and a proposal is selected. Incremental
+     * key-presses (like shift, control, or alt) are not triggerable.
+     * @param iter - a #GtkTextIter
+     * @param ch - a #gunichar of the character inserted
+     */
     isTrigger(iter: Gtk.TextIter, ch: number): boolean;
+    /**
+     * This function is used to determine if a key typed by the user should
+     * activate `proposal` (resulting in committing the text to the editor).
+     *
+     * This is useful when using languages where convention may lead to less
+     * typing by the user. One example may be the use of "." or "-" to expand
+     * a field access in the C programming language.
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     * @param keyval - a keyval such as [const@Gdk.KEY_period]
+     * @param state - a #GdkModifierType or 0
+     */
     keyActivates(context: CompletionContext, proposal: CompletionProposal, keyval: number, state: Gdk.ModifierType): boolean;
+    /**
+     * Providers should return a list of alternates to `proposal` or %NULL if
+     * there are no alternates available.
+     *
+     * This can be used by the completion view to allow the user to move laterally
+     * through similar proposals, such as overrides of methods by the same name.
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     */
     listAlternates(context: CompletionContext, proposal: CompletionProposal): GLib.PtrArray | null;
+    /**
+     * Completes an asynchronous operation to populate a completion provider.
+     * @param result - a #GAsyncResult provided to callback
+     */
     populateFinish(result: Gio.AsyncResult): Gio.ListModel;
+    /**
+     * This function can be used to filter results previously provided to
+     * the [class@CompletionContext] by the #GtkSourceCompletionProvider.
+     *
+     * This can happen as the user types additional text onto the word so
+     * that previously matched items may be removed from the list instead of
+     * generating new [iface@Gio.ListModel] of results.
+     * @param context - a #GtkSourceCompletionContext
+     * @param model - a #GListModel
+     */
     refilter(context: CompletionContext, model: Gio.ListModel): void;
     connect(signal: "notify", handler: (self: CompletionWords, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;

package/dist/generated/gtksource/completion-words.js

@@ -3,6 +3,13 @@ import { NativeError, getObject } from "@gtkx/ffi";
 import * as GLib from "../glib/index.js";
 import * as GObject from "../gobject/index.js";
 import * as Gio from "../gio/index.js";
+/**
+ * A [iface@CompletionProvider] for the completion of words.
+ *
+ * The `GtkSourceCompletionWords` is an example of an implementation of
+ * the [iface@CompletionProvider] interface. The proposals are words
+ * appearing in the registered [class@Gtk.TextBuffer]s.
+ */
 export class CompletionWords extends GObject.GObject {
     constructor(...args) {
         super(...args);
@@ -17,6 +24,10 @@ export class CompletionWords extends GObject.GObject {
             },
         ], { type: "gobject", borrowed: false });
     }
+    /**
+     * Registers `buffer` in the `words` provider.
+     * @param buffer - a #GtkTextBuffer
+     */
     register(buffer) {
         call("libgtksourceview-5.so.0", "gtk_source_completion_words_register", [
             {
@@ -29,6 +40,10 @@ export class CompletionWords extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Unregisters `buffer` from the `words` provider.
+     * @param buffer - a #GtkTextBuffer
+     */
     unregister(buffer) {
         call("libgtksourceview-5.so.0", "gtk_source_completion_words_unregister", [
             {
@@ -41,6 +56,18 @@ export class CompletionWords extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * This function requests `proposal` to be activated by the
+     * #GtkSourceCompletionProvider.
+     *
+     * What the provider does to activate the proposal is specific to that
+     * provider. Many providers may choose to insert a #GtkSourceSnippet with
+     * edit points the user may cycle through.
+     *
+     * See also: [class@Snippet], [class@SnippetChunk], [method@View.push_snippet]
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     */
     activate(context, proposal) {
         call("libgtksourceview-5.so.0", "gtk_source_completion_provider_activate", [
             {
@@ -57,6 +84,19 @@ export class CompletionWords extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * This function requests that the #GtkSourceCompletionProvider prepares
+     * `cell` to display the contents of @proposal.
+     *
+     * Based on `cells` column type, you may want to display different information.
+     *
+     * This allows for columns of information among completion proposals
+     * resulting in better alignment of similar content (icons, return types,
+     * method names, and parameter lists).
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     * @param cell - a #GtkSourceCompletionCell
+     */
     display(context, proposal, cell) {
         call("libgtksourceview-5.so.0", "gtk_source_completion_provider_display", [
             {
@@ -77,6 +117,16 @@ export class CompletionWords extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * This function should return the priority of `self` in @context.
+     *
+     * The priority is used to sort groups of completion proposals by
+     * provider so that higher priority providers results are shown
+     * above lower priority providers.
+     *
+     * Higher value indicates higher priority.
+     * @param context - a #GtkSourceCompletionContext
+     */
     getPriority(context) {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_provider_get_priority", [
             {
@@ -89,6 +139,12 @@ export class CompletionWords extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Gets the title of the completion provider, if any.
+     *
+     * Currently, titles are not displayed in the completion results, but may be
+     * at some point in the future when non-%NULL.
+     */
     getTitle() {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_provider_get_title", [
             {
@@ -97,6 +153,19 @@ export class CompletionWords extends GObject.GObject {
             },
         ], { type: "string" });
     }
+    /**
+     * This function is used to determine if a character inserted into the text
+     * editor should cause a new completion request to be triggered.
+     *
+     * An example would be period '.' which might indicate that the user wants
+     * to complete method or field names of an object.
+     *
+     * This method will only trigger when text is inserted into the #GtkTextBuffer
+     * while the completion list is visible and a proposal is selected. Incremental
+     * key-presses (like shift, control, or alt) are not triggerable.
+     * @param iter - a #GtkTextIter
+     * @param ch - a #gunichar of the character inserted
+     */
     isTrigger(iter, ch) {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_provider_is_trigger", [
             {
@@ -118,6 +187,18 @@ export class CompletionWords extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * This function is used to determine if a key typed by the user should
+     * activate `proposal` (resulting in committing the text to the editor).
+     *
+     * This is useful when using languages where convention may lead to less
+     * typing by the user. One example may be the use of "." or "-" to expand
+     * a field access in the C programming language.
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     * @param keyval - a keyval such as [const@Gdk.KEY_period]
+     * @param state - a #GdkModifierType or 0
+     */
     keyActivates(context, proposal, keyval, state) {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_provider_key_activates", [
             {
@@ -142,6 +223,15 @@ export class CompletionWords extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Providers should return a list of alternates to `proposal` or %NULL if
+     * there are no alternates available.
+     *
+     * This can be used by the completion view to allow the user to move laterally
+     * through similar proposals, such as overrides of methods by the same name.
+     * @param context - a #GtkSourceCompletionContext
+     * @param proposal - a #GtkSourceCompletionProposal
+     */
     listAlternates(context, proposal) {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_completion_provider_list_alternates", [
             {
@@ -166,6 +256,10 @@ export class CompletionWords extends GObject.GObject {
             return null;
         return getObject(ptr, GLib.PtrArray);
     }
+    /**
+     * Completes an asynchronous operation to populate a completion provider.
+     * @param result - a #GAsyncResult provided to callback
+     */
     populateFinish(result) {
         const error = { value: null };
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_completion_provider_populate_finish", [
@@ -194,6 +288,16 @@ export class CompletionWords extends GObject.GObject {
         }
         return getObject(ptr, Gio.ListModel);
     }
+    /**
+     * This function can be used to filter results previously provided to
+     * the [class@CompletionContext] by the #GtkSourceCompletionProvider.
+     *
+     * This can happen as the user types additional text onto the word so
+     * that previously matched items may be removed from the list instead of
+     * generating new [iface@Gio.ListModel] of results.
+     * @param context - a #GtkSourceCompletionContext
+     * @param model - a #GListModel
+     */
     refilter(context, model) {
         call("libgtksourceview-5.so.0", "gtk_source_completion_provider_refilter", [
             {

package/dist/generated/gtksource/completion.d.ts

@@ -7,16 +7,62 @@ import * as Pango from "../pango/index.js";
 export declare class Completion extends GObject.GObject {
     constructor(...args: unknown[]);
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * This will add `<b>` tags around matched characters in `haystack` based on @casefold_query.
+     * @param haystack - the string to be highlighted
+     * @param casefoldQuery - the typed-text used to highlight @haystack
+     */
     static fuzzyHighlight(haystack: string, casefoldQuery: string): Pango.AttrList;
+    /**
+     * This helper function can do a fuzzy match for you giving a haystack and
+     * casefolded needle.
+     *
+     * Casefold your needle using [func@GLib.utf8_casefold] before
+     * running the query.
+     *
+     * Score will be set with the score of the match upon success. Otherwise,
+     * it will be set to zero.
+     * @param haystack - the string to be searched.
+     * @param casefoldNeedle - A g_utf8_casefold() version of the needle.
+     * @param priority - An optional location for the score of the match
+     */
     static fuzzyMatch(casefoldNeedle: string, haystack?: string | null, priority?: Ref<number> | null): boolean;
+    /**
+     * Adds a [iface@CompletionProvider] to the list of providers to be queried
+     * for completion results.
+     * @param provider - a #GtkSourceCompletionProvider
+     */
     addProvider(provider: CompletionProvider): void;
     blockInteractive(): void;
+    /**
+     * Gets the connected [class@View]'s [class@Buffer]
+     */
     getBuffer(): Buffer;
     getPageSize(): number;
+    /**
+     * Gets the [class@View] that owns the [class@Completion].
+     */
     getView(): View;
+    /**
+     * Emits the "hide" signal.
+     *
+     * When the "hide" signal is emitted, the completion window will be
+     * dismissed.
+     */
     hide(): void;
+    /**
+     * Removes a [iface@CompletionProvider] previously added with
+     * [method@Completion.add_provider].
+     * @param provider - a #GtkSourceCompletionProvider
+     */
     removeProvider(provider: CompletionProvider): void;
     setPageSize(pageSize: number): void;
+    /**
+     * Emits the "show" signal.
+     *
+     * When the "show" signal is emitted, the completion window will be
+     * displayed if there are any results available.
+     */
     show(): void;
     unblockInteractive(): void;
     connect(signal: "hide", handler: (self: Completion) => void, after?: boolean): number;

package/dist/generated/gtksource/completion.js

@@ -3,6 +3,37 @@ import { getObject } from "@gtkx/ffi";
 import { Buffer } from "./buffer.js";
 import { View } from "./view.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * Main Completion Object.
+ *
+ * The completion system helps the user when they writes some text,
+ * such as words, command names, functions, and suchlike. Proposals can
+ * be shown, to complete the text the user is writing. Each proposal can
+ * contain an additional piece of information (for example
+ * documentation), that is displayed when the "Details" button is
+ * clicked.
+ *
+ * Proposals are created via a [iface@CompletionProvider]. There can
+ * be for example a provider to complete words (see [class@CompletionWords]),
+ * another provider for the completion of
+ * function names, etc. To add a provider, call
+ * [method@Completion.add_provider].
+ *
+ * The [iface@CompletionProposal] interface represents a proposal.
+ *
+ * If a proposal contains extra information (see
+ * %GTK_SOURCE_COMPLETION_COLUMN_DETAILS), it will be
+ * displayed in a supplemental details window, which appears when
+ * the "Details" button is clicked.
+ *
+ * Each [class@View] object is associated with a [class@Completion]
+ * instance. This instance can be obtained with
+ * [method@View.get_completion]. The [class@View] class contains also the
+ * [signal@View::show-completion] signal.
+ *
+ * A same [iface@CompletionProvider] object can be used for several
+ * `GtkSourceCompletion`'s.
+ */
 const SIGNAL_META = {
     hide: { params: [], returnType: { type: "undefined" } },
     "provider-added": {
@@ -26,6 +57,11 @@ export class Completion extends GObject.GObject {
             { type: { type: "gobject" }, value: null },
         ], { type: "gobject", borrowed: true });
     }
+    /**
+     * This will add `<b>` tags around matched characters in `haystack` based on @casefold_query.
+     * @param haystack - the string to be highlighted
+     * @param casefoldQuery - the typed-text used to highlight @haystack
+     */
     static fuzzyHighlight(haystack, casefoldQuery) {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_fuzzy_highlight", [
             {
@@ -43,6 +79,19 @@ export class Completion extends GObject.GObject {
             lib: "libgtksourceview-5.so.0",
         });
     }
+    /**
+     * This helper function can do a fuzzy match for you giving a haystack and
+     * casefolded needle.
+     *
+     * Casefold your needle using [func@GLib.utf8_casefold] before
+     * running the query.
+     *
+     * Score will be set with the score of the match upon success. Otherwise,
+     * it will be set to zero.
+     * @param haystack - the string to be searched.
+     * @param casefoldNeedle - A g_utf8_casefold() version of the needle.
+     * @param priority - An optional location for the score of the match
+     */
     static fuzzyMatch(casefoldNeedle, haystack, priority) {
         return call("libgtksourceview-5.so.0", "gtk_source_completion_fuzzy_match", [
             {
@@ -64,6 +113,11 @@ export class Completion extends GObject.GObject {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Adds a [iface@CompletionProvider] to the list of providers to be queried
+     * for completion results.
+     * @param provider - a #GtkSourceCompletionProvider
+     */
     addProvider(provider) {
         call("libgtksourceview-5.so.0", "gtk_source_completion_add_provider", [
             {
@@ -84,6 +138,9 @@ export class Completion extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the connected [class@View]'s [class@Buffer]
+     */
     getBuffer() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_completion_get_buffer", [
             {
@@ -101,6 +158,9 @@ export class Completion extends GObject.GObject {
             },
         ], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Gets the [class@View] that owns the [class@Completion].
+     */
     getView() {
         const ptr = call("libgtksourceview-5.so.0", "gtk_source_completion_get_view", [
             {
@@ -110,6 +170,12 @@ export class Completion extends GObject.GObject {
         ], { type: "gobject", borrowed: true });
         return getObject(ptr, View);
     }
+    /**
+     * Emits the "hide" signal.
+     *
+     * When the "hide" signal is emitted, the completion window will be
+     * dismissed.
+     */
     hide() {
         call("libgtksourceview-5.so.0", "gtk_source_completion_hide", [
             {
@@ -118,6 +184,11 @@ export class Completion extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Removes a [iface@CompletionProvider] previously added with
+     * [method@Completion.add_provider].
+     * @param provider - a #GtkSourceCompletionProvider
+     */
     removeProvider(provider) {
         call("libgtksourceview-5.so.0", "gtk_source_completion_remove_provider", [
             {
@@ -142,6 +213,12 @@ export class Completion extends GObject.GObject {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Emits the "show" signal.
+     *
+     * When the "show" signal is emitted, the completion window will be
+     * displayed if there are any results available.
+     */
     show() {
         call("libgtksourceview-5.so.0", "gtk_source_completion_show", [
             {