@gtkx/ffi 0.9.1 → 0.9.2

package/dist/generated/adw/about-dialog.d.ts

@@ -14,21 +14,21 @@ export declare class AboutDialog extends Dialog {
      * This automatically sets the following properties with the following AppStream
      * values:
      *
-     * * [property@AboutDialog:application-icon] is set from the `<id>`
-     * * [property@AboutDialog:application-name] is set from the `<name>`
-     * * [property@AboutDialog:developer-name] is set from the `<name>` within
+     * * {@link AboutDialog.application-icon} is set from the `<id>`
+     * * {@link AboutDialog.application-name} is set from the `<name>`
+     * * {@link AboutDialog.developer-name} is set from the `<name>` within
      * `<developer>`
-     * * [property@AboutDialog:version] is set from the version of the latest release
-     * * [property@AboutDialog:website] is set from the `<url type="homepage">`
-     * * [property@AboutDialog:support-url] is set from the `<url type="help">`
-     * * [property@AboutDialog:issue-url] is set from the `<url type="bugtracker">`
-     * * [property@AboutDialog:license-type] is set from the `<project_license>`.
+     * * {@link AboutDialog.version} is set from the version of the latest release
+     * * {@link AboutDialog.website} is set from the `<url type="homepage">`
+     * * {@link AboutDialog.support-url} is set from the `<url type="help">`
+     * * {@link AboutDialog.issue-url} is set from the `<url type="bugtracker">`
+     * * {@link AboutDialog.license-type} is set from the `<project_license>`.
      * If the license type retrieved from AppStream is not listed in
-     * [enum@Gtk.License], it will be set to `GTK_LICENCE_CUSTOM`.
+     * {@link Gtk.License}, it will be set to `GTK_LICENCE_CUSTOM`.
      *
      * If `release_notes_version` is not `NULL`,
-     * [property@AboutDialog:release-notes-version] is set to match it, while
-     * [property@AboutDialog:release-notes] is set from the AppStream release
+     * {@link AboutDialog.release-notes-version} is set to match it, while
+     * {@link AboutDialog.release-notes} is set from the AppStream release
      * description for that version.
      * @param resourcePath - The resource to use
      * @param releaseNotesVersion - The version to retrieve release notes for
@@ -46,12 +46,12 @@ export declare class AboutDialog extends Dialog {
      *
      * See also:
      *
-     * * [property@AboutDialog:developers]
-     * * [property@AboutDialog:designers]
-     * * [property@AboutDialog:artists]
-     * * [property@AboutDialog:documenters]
-     * * [property@AboutDialog:translator-credits]
-     * * [method@AboutDialog.add_credit_section]
+     * * {@link AboutDialog.developers}
+     * * {@link AboutDialog.designers}
+     * * {@link AboutDialog.artists}
+     * * {@link AboutDialog.documenters}
+     * * {@link AboutDialog.translator-credits}
+     * * {@link AboutDialog.add_credit_section}
      * @param name - the section name
      * @param people - the list of names
      */
@@ -66,12 +66,12 @@ export declare class AboutDialog extends Dialog {
      *
      * See also:
      *
-     * * [property@AboutDialog:developers]
-     * * [property@AboutDialog:designers]
-     * * [property@AboutDialog:artists]
-     * * [property@AboutDialog:documenters]
-     * * [property@AboutDialog:translator-credits]
-     * * [method@AboutDialog.add_acknowledgement_section]
+     * * {@link AboutDialog.developers}
+     * * {@link AboutDialog.designers}
+     * * {@link AboutDialog.artists}
+     * * {@link AboutDialog.documenters}
+     * * {@link AboutDialog.translator-credits}
+     * * {@link AboutDialog.add_acknowledgement_section}
      * @param name - the section name
      * @param people - the list of names
      */
@@ -81,9 +81,9 @@ export declare class AboutDialog extends Dialog {
      *
      * Extra sections will be displayed below the application's own information.
      *
-     * The parameters @copyright, `license_type` and `license` will be used to present
-     * the it the same way as [property@AboutDialog:copyright],
-     * [property@AboutDialog:license-type] and [property@AboutDialog:license] are
+     * The parameters `copyright`, `license_type` and `license` will be used to present
+     * the it the same way as {@link AboutDialog.copyright},
+     * {@link AboutDialog.license-type} and {@link AboutDialog.license} are
      * for the application's own information.
      *
      * See those properties for more details.
@@ -130,17 +130,17 @@ export declare class AboutDialog extends Dialog {
      *
      * Underlines in `title` will be interpreted as indicating a mnemonic.
      *
-     * See [property@AboutDialog:website].
+     * See {@link AboutDialog.website}.
      * @param title - the link title
      * @param url - the link URL
      */
     addLink(title: string, url: string): void;
     /**
-     * Adds another application to @self.
+     * Adds another application to `self`.
      *
      * The application will be displayed at the bottom of the main page, in a
      * separate section. Each added application will be presented as a row with
-     * `title` and @summary, as well as an icon with the name @appid. Clicking the
+     * `title` and `summary`, as well as an icon with the name `appid`. Clicking the
      * row will show `appid` in the software center app.
      *
      * This can be used to link to your other applications if you have multiple.
@@ -159,11 +159,11 @@ export declare class AboutDialog extends Dialog {
      */
     addOtherApp(appid: string, name: string, summary: string): void;
     /**
-     * Gets the name of the application icon for @self.
+     * Gets the name of the application icon for `self`.
      */
     getApplicationIcon(): string;
     /**
-     * Gets the application name for @self.
+     * Gets the application name for `self`.
      */
     getApplicationName(): string;
     /**
@@ -175,15 +175,15 @@ export declare class AboutDialog extends Dialog {
      */
     getComments(): string;
     /**
-     * Gets the copyright information for @self.
+     * Gets the copyright information for `self`.
      */
     getCopyright(): string;
     /**
-     * Gets the debug information for @self.
+     * Gets the debug information for `self`.
      */
     getDebugInfo(): string;
     /**
-     * Gets the debug information filename for @self.
+     * Gets the debug information filename for `self`.
      */
     getDebugInfoFilename(): string;
     /**
@@ -191,7 +191,7 @@ export declare class AboutDialog extends Dialog {
      */
     getDesigners(): string[] | null;
     /**
-     * Gets the developer name for @self.
+     * Gets the developer name for `self`.
      */
     getDeveloperName(): string;
     /**
@@ -203,19 +203,19 @@ export declare class AboutDialog extends Dialog {
      */
     getDocumenters(): string[] | null;
     /**
-     * Gets the issue tracker URL for @self.
+     * Gets the issue tracker URL for `self`.
      */
     getIssueUrl(): string;
     /**
-     * Gets the license for @self.
+     * Gets the license for `self`.
      */
     getLicense(): string;
     /**
-     * Gets the license type for @self.
+     * Gets the license type for `self`.
      */
     getLicenseType(): Gtk.License;
     /**
-     * Gets the release notes for @self.
+     * Gets the release notes for `self`.
      */
     getReleaseNotes(): string;
     /**
@@ -223,7 +223,7 @@ export declare class AboutDialog extends Dialog {
      */
     getReleaseNotesVersion(): string;
     /**
-     * Gets the URL of the support page for @self.
+     * Gets the URL of the support page for `self`.
      */
     getSupportUrl(): string;
     /**
@@ -231,22 +231,22 @@ export declare class AboutDialog extends Dialog {
      */
     getTranslatorCredits(): string;
     /**
-     * Gets the version for @self.
+     * Gets the version for `self`.
      */
     getVersion(): string;
     /**
-     * Gets the application website URL for @self.
+     * Gets the application website URL for `self`.
      */
     getWebsite(): string;
     /**
-     * Sets the name of the application icon for @self.
+     * Sets the name of the application icon for `self`.
      *
      * The icon is displayed at the top of the main page.
      * @param applicationIcon - the application icon name
      */
     setApplicationIcon(applicationIcon: string): void;
     /**
-     * Sets the application name for @self.
+     * Sets the application name for `self`.
      *
      * The name is displayed at the top of the main page.
      * @param applicationName - the application name
@@ -262,12 +262,12 @@ export declare class AboutDialog extends Dialog {
      *
      * See also:
      *
-     * * [property@AboutDialog:developers]
-     * * [property@AboutDialog:designers]
-     * * [property@AboutDialog:documenters]
-     * * [property@AboutDialog:translator-credits]
-     * * [method@AboutDialog.add_credit_section]
-     * * [method@AboutDialog.add_acknowledgement_section]
+     * * {@link AboutDialog.developers}
+     * * {@link AboutDialog.designers}
+     * * {@link AboutDialog.documenters}
+     * * {@link AboutDialog.translator-credits}
+     * * {@link AboutDialog.add_credit_section}
+     * * {@link AboutDialog.add_acknowledgement_section}
      * @param artists - the list of artists
      */
     setArtists(artists?: string[]): void;
@@ -276,13 +276,13 @@ export declare class AboutDialog extends Dialog {
      *
      * Comments will be shown on the Details page, above links.
      *
-     * Unlike [property@Gtk.AboutDialog:comments], this string can be long and
+     * Unlike {@link Gtk.AboutDialog.comments}, this string can be long and
      * detailed. It can also contain links and Pango markup.
      * @param comments - the comments
      */
     setComments(comments: string): void;
     /**
-     * Sets the copyright information for @self.
+     * Sets the copyright information for `self`.
      *
      * This should be a short string of one or two lines, for example:
      * `© 2022 Example`.
@@ -290,20 +290,20 @@ export declare class AboutDialog extends Dialog {
      * The copyright information will be displayed on the Legal page, before the
      * application license.
      *
-     * [method@AboutDialog.add_legal_section] can be used to add copyright
+     * {@link AboutDialog.add_legal_section} can be used to add copyright
      * information for the application dependencies or other components.
      * @param copyright - the copyright information
      */
     setCopyright(copyright: string): void;
     /**
-     * Sets the debug information for @self.
+     * Sets the debug information for `self`.
      *
      * Debug information will be shown on the Troubleshooting page. It's intended
      * to be attached to issue reports when reporting issues against the
      * application.
      *
      * `AdwAboutDialog` provides a quick way to save debug information to a file.
-     * When saving, [property@AboutDialog:debug-info-filename] would be used as
+     * When saving, {@link AboutDialog.debug-info-filename} would be used as
      * the suggested filename.
      *
      * Debug information cannot contain markup or links.
@@ -311,12 +311,12 @@ export declare class AboutDialog extends Dialog {
      */
     setDebugInfo(debugInfo: string): void;
     /**
-     * Sets the debug information filename for @self.
+     * Sets the debug information filename for `self`.
      *
      * It will be used as the suggested filename when saving debug information to a
      * file.
      *
-     * See [property@AboutDialog:debug-info].
+     * See {@link AboutDialog.debug-info}.
      * @param filename - the debug info filename
      */
     setDebugInfoFilename(filename: string): void;
@@ -330,24 +330,24 @@ export declare class AboutDialog extends Dialog {
      *
      * See also:
      *
-     * * [property@AboutDialog:developers]
-     * * [property@AboutDialog:artists]
-     * * [property@AboutDialog:documenters]
-     * * [property@AboutDialog:translator-credits]
-     * * [method@AboutDialog.add_credit_section]
-     * * [method@AboutDialog.add_acknowledgement_section]
+     * * {@link AboutDialog.developers}
+     * * {@link AboutDialog.artists}
+     * * {@link AboutDialog.documenters}
+     * * {@link AboutDialog.translator-credits}
+     * * {@link AboutDialog.add_credit_section}
+     * * {@link AboutDialog.add_acknowledgement_section}
      * @param designers - the list of designers
      */
     setDesigners(designers?: string[]): void;
     /**
-     * Sets the developer name for @self.
+     * Sets the developer name for `self`.
      *
      * The developer name is displayed on the main page, under the application name.
      *
      * If the application is developed by multiple people, the developer name can be
      * set to values like "AppName team", "AppName developers" or
      * "The AppName project", and the individual contributors can be listed on the
-     * Credits page, with [property@AboutDialog:developers] and related properties.
+     * Credits page, with {@link AboutDialog.developers} and related properties.
      * @param developerName - the developer name
      */
     setDeveloperName(developerName: string): void;
@@ -361,12 +361,12 @@ export declare class AboutDialog extends Dialog {
      *
      * See also:
      *
-     * * [property@AboutDialog:designers]
-     * * [property@AboutDialog:artists]
-     * * [property@AboutDialog:documenters]
-     * * [property@AboutDialog:translator-credits]
-     * * [method@AboutDialog.add_credit_section]
-     * * [method@AboutDialog.add_acknowledgement_section]
+     * * {@link AboutDialog.designers}
+     * * {@link AboutDialog.artists}
+     * * {@link AboutDialog.documenters}
+     * * {@link AboutDialog.translator-credits}
+     * * {@link AboutDialog.add_credit_section}
+     * * {@link AboutDialog.add_acknowledgement_section}
      * @param developers - the list of developers
      */
     setDevelopers(developers?: string[]): void;
@@ -380,29 +380,29 @@ export declare class AboutDialog extends Dialog {
      *
      * See also:
      *
-     * * [property@AboutDialog:developers]
-     * * [property@AboutDialog:designers]
-     * * [property@AboutDialog:artists]
-     * * [property@AboutDialog:translator-credits]
-     * * [method@AboutDialog.add_credit_section]
-     * * [method@AboutDialog.add_acknowledgement_section]
+     * * {@link AboutDialog.developers}
+     * * {@link AboutDialog.designers}
+     * * {@link AboutDialog.artists}
+     * * {@link AboutDialog.translator-credits}
+     * * {@link AboutDialog.add_credit_section}
+     * * {@link AboutDialog.add_acknowledgement_section}
      * @param documenters - the list of documenters
      */
     setDocumenters(documenters?: string[]): void;
     /**
-     * Sets the issue tracker URL for @self.
+     * Sets the issue tracker URL for `self`.
      *
      * The issue tracker link is displayed on the main page.
      * @param issueUrl - the issue tracker URL
      */
     setIssueUrl(issueUrl: string): void;
     /**
-     * Sets the license for @self.
+     * Sets the license for `self`.
      *
      * This can be used to set a custom text for the license if it can't be set via
-     * [property@AboutDialog:license-type].
+     * {@link AboutDialog.license-type}.
      *
-     * When set, [property@AboutDialog:license-type] will be set to
+     * When set, {@link AboutDialog.license-type} will be set to
      * `GTK_LICENSE_CUSTOM`.
      *
      * The license text will be displayed on the Legal page, below the copyright
@@ -410,7 +410,7 @@ export declare class AboutDialog extends Dialog {
      *
      * License text can contain Pango markup and links.
      *
-     * [method@AboutDialog.add_legal_section] can be used to add license information
+     * {@link AboutDialog.add_legal_section} can be used to add license information
      * for the application dependencies or other components.
      * @param license - the license
      */
@@ -419,24 +419,24 @@ export declare class AboutDialog extends Dialog {
      * Sets the license for `self` from a list of known licenses.
      *
      * If the application's license is not in the list,
-     * [property@AboutDialog:license] can be used instead. The license type will be
+     * {@link AboutDialog.license} can be used instead. The license type will be
      * automatically set to `GTK_LICENSE_CUSTOM` in that case.
      *
      * If `license_type` is `GTK_LICENSE_UNKNOWN`, no information will be displayed.
      *
      * If `license_type` is different from `GTK_LICENSE_CUSTOM`.
-     * [property@AboutDialog:license] will be cleared out.
+     * {@link AboutDialog.license} will be cleared out.
      *
      * The license description will be displayed on the Legal page, below the
      * copyright information.
      *
-     * [method@AboutDialog.add_legal_section] can be used to add license information
+     * {@link AboutDialog.add_legal_section} can be used to add license information
      * for the application dependencies or other components.
      * @param licenseType - the license type
      */
     setLicenseType(licenseType: Gtk.License): void;
     /**
-     * Sets the release notes for @self.
+     * Sets the release notes for `self`.
      *
      * Release notes are displayed on the the What's New page.
      *
@@ -458,8 +458,8 @@ export declare class AboutDialog extends Dialog {
      * Nested lists are not supported.
      *
      * `AdwAboutDialog` displays the version above the release notes. If set, the
-     * [property@AboutDialog:release-notes-version] of the property will be used
-     * as the version; otherwise, [property@AboutDialog:version] is used.
+     * {@link AboutDialog.release-notes-version} of the property will be used
+     * as the version; otherwise, {@link AboutDialog.version} is used.
      * @param releaseNotes - the release notes
      */
     setReleaseNotes(releaseNotes: string): void;
@@ -469,18 +469,18 @@ export declare class AboutDialog extends Dialog {
      * The release notes version is displayed on the What's New page, above the
      * release notes.
      *
-     * If not set, [property@AboutDialog:version] will be used instead.
+     * If not set, {@link AboutDialog.version} will be used instead.
      *
      * For example, an application with the current version 2.0.2 might want to
      * keep the release notes from 2.0.0, and set the release notes version
      * accordingly.
      *
-     * See [property@AboutDialog:release-notes].
+     * See {@link AboutDialog.release-notes}.
      * @param version - the release notes version
      */
     setReleaseNotesVersion(version: string): void;
     /**
-     * Sets the URL of the support page for @self.
+     * Sets the URL of the support page for `self`.
      *
      * The support page link is displayed on the main page.
      * @param supportUrl - the support page URL
@@ -500,32 +500,32 @@ export declare class AboutDialog extends Dialog {
      *
      * See also:
      *
-     * * [property@AboutDialog:developers]
-     * * [property@AboutDialog:designers]
-     * * [property@AboutDialog:artists]
-     * * [property@AboutDialog:documenters]
-     * * [method@AboutDialog.add_credit_section]
-     * * [method@AboutDialog.add_acknowledgement_section]
+     * * {@link AboutDialog.developers}
+     * * {@link AboutDialog.designers}
+     * * {@link AboutDialog.artists}
+     * * {@link AboutDialog.documenters}
+     * * {@link AboutDialog.add_credit_section}
+     * * {@link AboutDialog.add_acknowledgement_section}
      * @param translatorCredits - the translator credits
      */
     setTranslatorCredits(translatorCredits: string): void;
     /**
-     * Sets the version for @self.
+     * Sets the version for `self`.
      *
      * The version is displayed on the main page.
      *
-     * If [property@AboutDialog:release-notes-version] is not set, the version will
+     * If {@link AboutDialog.release-notes-version} is not set, the version will
      * also be displayed above the release notes on the What's New page.
      * @param version - the version
      */
     setVersion(version: string): void;
     /**
-     * Sets the application website URL for @self.
+     * Sets the application website URL for `self`.
      *
      * Website is displayed on the Details page, below comments, or on the main page
      * if the Details page doesn't have any other content.
      *
-     * Applications can add other links below, see [method@AboutDialog.add_link].
+     * Applications can add other links below, see {@link AboutDialog.add_link}.
      * @param website - the website URL
      */
     setWebsite(website: string): void;