@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/glib/key-file.d.ts

@@ -1,54 +1,660 @@
 import { Ref } from "@gtkx/native";
 import { KeyFileFlags } from "./enums.js";
 import { Bytes } from "./bytes.js";
+/**
+ * `GKeyFile` parses .ini-like config files.
+ *
+ * `GKeyFile` lets you parse, edit or create files containing groups of
+ * key-value pairs, which we call ‘key files’ for lack of a better name.
+ * Several freedesktop.org specifications use key files. For example, the
+ * [Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/latest/)
+ * and the [Icon Theme Specification](https://specifications.freedesktop.org/icon-theme-spec/latest/).
+ *
+ * The syntax of key files is described in detail in the
+ * [Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/latest/),
+ * here is a quick summary: Key files consists of groups of key-value pairs, interspersed
+ * with comments.
+ *
+ * ```txt
+ * # this is just an example
+ * # there can be comments before the first group
+ *
+ * [First Group]
+ *
+ * Name=Key File Example\tthis value shows\nescaping
+ *
+ * # localized strings are stored in multiple key-value pairs
+ * Welcome=Hello
+ * Welcome[de]=Hallo
+ * Welcome[fr_FR]=Bonjour
+ * Welcome[it]=Ciao
+ *
+ * [Another Group]
+ *
+ * Numbers=2;20;-200;0
+ *
+ * Booleans=true;false;true;true
+ * ```
+ *
+ * Lines beginning with a `#` and blank lines are considered comments.
+ *
+ * Groups are started by a header line containing the group name enclosed
+ * in `[` and `]`, and ended implicitly by the start of the next group or
+ * the end of the file. Each key-value pair must be contained in a group.
+ *
+ * Key-value pairs generally have the form `key=value`, with the exception
+ * of localized strings, which have the form `key[locale]=value`, with a
+ * locale identifier of the form `lang_COUNTRY@MODIFIER` where `COUNTRY`
+ * and `MODIFIER` are optional. As a special case, the locale `C` is associated
+ * with the untranslated pair `key=value` (since GLib 2.84). Space before and
+ * after the `=` character is ignored. Newline, tab, carriage return and
+ * backslash characters in value are escaped as `\n`, `\t`, `\r`, and `\\\\`,
+ * respectively. To preserve leading spaces in values, these can also be escaped
+ * as `\s`.
+ *
+ * Key files can store strings (possibly with localized variants), integers,
+ * booleans and lists of these. Lists are separated by a separator character,
+ * typically `;` or `,`. To use the list separator character in a value in
+ * a list, it has to be escaped by prefixing it with a backslash.
+ *
+ * This syntax is obviously inspired by the .ini files commonly met
+ * on Windows, but there are some important differences:
+ *
+ * - .ini files use the `;` character to begin comments,
+ * key files use the `#` character.
+ *
+ * - Key files do not allow for ungrouped keys meaning only
+ * comments can precede the first group.
+ *
+ * - Key files are always encoded in UTF-8.
+ *
+ * - Key and Group names are case-sensitive. For example, a group called
+ * `[GROUP]` is a different from `[group]`.
+ *
+ * - .ini files don’t have a strongly typed boolean entry type,
+ * they only have `GetProfileInt()`. In key files, only
+ * `true` and `false` (in lower case) are allowed.
+ *
+ * Note that in contrast to the
+ * [Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/latest/),
+ * groups in key files may contain the same key multiple times; the last entry wins.
+ * Key files may also contain multiple groups with the same name; they are merged
+ * together. Another difference is that keys and group names in key files are not
+ * restricted to ASCII characters.
+ *
+ * Here is an example of loading a key file and reading a value:
+ *
+ * ```c
+ * g_autoptr(GError) error = NULL;
+ * g_autoptr(GKeyFile) key_file = g_key_file_new ();
+ *
+ * if (!g_key_file_load_from_file (key_file, "key-file.ini", flags, &error))
+ * {
+ * if (!g_error_matches (error, G_FILE_ERROR, G_FILE_ERROR_NOENT))
+ * g_warning ("Error loading key file: %s", error->message);
+ * return;
+ * }
+ *
+ * g_autofree gchar *val = g_key_file_get_string (key_file, "Group Name", "SomeKey", &error);
+ * if (val == NULL &&
+ * !g_error_matches (error, G_KEY_FILE_ERROR, G_KEY_FILE_ERROR_KEY_NOT_FOUND))
+ * {
+ * g_warning ("Error finding key in key file: %s", error->message);
+ * return;
+ * }
+ * else if (val == NULL)
+ * {
+ * // Fall back to a default value.
+ * val = g_strdup ("default-value");
+ * }
+ * ```
+ *
+ * Here is an example of creating and saving a key file:
+ *
+ * ```c
+ * g_autoptr(GKeyFile) key_file = g_key_file_new ();
+ * const gchar *val = …;
+ * g_autoptr(GError) error = NULL;
+ *
+ * g_key_file_set_string (key_file, "Group Name", "SomeKey", val);
+ *
+ * // Save as a file.
+ * if (!g_key_file_save_to_file (key_file, "key-file.ini", &error))
+ * {
+ * g_warning ("Error saving key file: %s", error->message);
+ * return;
+ * }
+ *
+ * // Or store to a GBytes for use elsewhere.
+ * gsize data_len;
+ * g_autofree guint8 *data = (guint8 *) g_key_file_to_data (key_file, &data_len, &error);
+ * if (data == NULL)
+ * {
+ * g_warning ("Error saving key file: %s", error->message);
+ * return;
+ * }
+ * g_autoptr(GBytes) bytes = g_bytes_new_take (g_steal_pointer (&data), data_len);
+ * ```
+ */
 export declare class KeyFile {
     ptr: unknown;
+    /**
+     * Creates a new empty [struct@GLib.KeyFile] object.
+     *
+     * Use [method@GLib.KeyFile.load_from_file],
+     * [method@GLib.KeyFile.load_from_data], [method@GLib.KeyFile.load_from_dirs] or
+     * [method@GLib.KeyFile.load_from_data_dirs] to
+     * read an existing key file.
+     */
     constructor();
     protected createPtr(_args: unknown[]): unknown;
     static errorQuark(): number;
+    /**
+     * Returns the value associated with `key` under `group_name` as a
+     * boolean.
+     *
+     * If `key` cannot be found then [error@GLib.KeyFileError.KEY_NOT_FOUND] is
+     * returned. Likewise, if the value associated with `key` cannot be interpreted
+     * as a boolean then [error@GLib.KeyFileError.INVALID_VALUE] is returned.
+     * @param groupName - a group name
+     * @param key - a key
+     */
     getBoolean(groupName: string, key: string): boolean;
+    /**
+     * Returns the values associated with `key` under `group_name` as
+     * booleans.
+     *
+     * If `key` cannot be found then [error@GLib.KeyFileError.KEY_NOT_FOUND] is
+     * returned. Likewise, if the values associated with `key` cannot be interpreted
+     * as booleans then [error@GLib.KeyFileError.INVALID_VALUE] is returned.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param length - the number of booleans returned
+     */
     getBooleanList(groupName: string, key: string, length: Ref<number>): boolean[];
+    /**
+     * Retrieves a comment above `key` from @group_name.
+     *
+     * If `key` is `NULL` then `comment` will be read from above
+     * @group_name. If both `key` and `group_name` are `NULL`, then
+     * `comment` will be read from above the first group in the file.
+     *
+     * Note that the returned string does not include the `#` comment markers,
+     * but does include any whitespace after them (on each line). It includes
+     * the line breaks between lines, but does not include the final line break.
+     * @param groupName - a group name, or `NULL` to get a top-level comment
+     * @param key - a key, or `NULL` to get a group comment
+     */
     getComment(groupName?: string | null, key?: string | null): string;
+    /**
+     * Returns the value associated with `key` under `group_name` as a double.
+     *
+     * If `key` cannot be found then [error@GLib.KeyFileError.KEY_NOT_FOUND] is
+     * returned. Likewise, if the value associated with `key` cannot be interpreted
+     * as a double then [error@GLib.KeyFileError.INVALID_VALUE] is returned.
+     * @param groupName - a group name
+     * @param key - a key
+     */
     getDouble(groupName: string, key: string): number;
+    /**
+     * Returns the values associated with `key` under `group_name` as
+     * doubles.
+     *
+     * If `key` cannot be found then [error@GLib.KeyFileError.KEY_NOT_FOUND] is
+     * returned. Likewise, if the values associated with `key` cannot be interpreted
+     * as doubles then [error@GLib.KeyFileError.INVALID_VALUE] is returned.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param length - the number of doubles returned
+     */
     getDoubleList(groupName: string, key: string, length: Ref<number>): number[];
+    /**
+     * Returns all groups in the key file loaded with @key_file.
+     *
+     * The array of returned groups will be `NULL`-terminated, so
+     * `length` may optionally be `NULL`.
+     * @param length - return location for the number of returned groups,
+     */
     getGroups(length?: Ref<number> | null): string[];
+    /**
+     * Returns the value associated with `key` under `group_name` as a signed
+     * 64-bit integer.
+     *
+     * This is similar to [method@GLib.KeyFile.get_integer] but can return
+     * 64-bit results without truncation.
+     * @param groupName - a group name
+     * @param key - a key
+     */
     getInt64(groupName: string, key: string): number;
+    /**
+     * Returns the value associated with `key` under `group_name` as an
+     * integer.
+     *
+     * If `key` cannot be found then [error@GLib.KeyFileError.KEY_NOT_FOUND] is
+     * returned. Likewise, if the value associated with `key` cannot be interpreted
+     * as an integer, or is out of range for a `gint`, then
+     * [error@GLib.KeyFileError.INVALID_VALUE] is returned.
+     * @param groupName - a group name
+     * @param key - a key
+     */
     getInteger(groupName: string, key: string): number;
+    /**
+     * Returns the values associated with `key` under `group_name` as
+     * integers.
+     *
+     * If `key` cannot be found then [error@GLib.KeyFileError.KEY_NOT_FOUND] is
+     * returned. Likewise, if the values associated with `key` cannot be interpreted
+     * as integers, or are out of range for `gint`, then
+     * [error@GLib.KeyFileError.INVALID_VALUE] is returned.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param length - the number of integers returned
+     */
     getIntegerList(groupName: string, key: string, length: Ref<number>): number[];
+    /**
+     * Returns all keys for the group name @group_name.
+     *
+     * The array of returned keys will be `NULL`-terminated, so `length` may
+     * optionally be `NULL`. If the `group_name` cannot be found,
+     * [error@GLib.KeyFileError.GROUP_NOT_FOUND] is returned.
+     * @param groupName - a group name
+     * @param length - return location for the number of keys returned,
+     */
     getKeys(groupName: string, length?: Ref<number> | null): string[];
+    /**
+     * Returns the actual locale which the result of
+     * [method@GLib.KeyFile.get_locale_string] or
+     * [method@GLib.KeyFile.get_locale_string_list] came from.
+     *
+     * If calling [method@GLib.KeyFile.get_locale_string] or
+     * [method@GLib.KeyFile.get_locale_string_list] with exactly the same @key_file,
+     * @group_name, `key` and @locale, the result of those functions will
+     * have originally been tagged with the locale that is the result of
+     * this function.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param locale - a locale identifier or `NULL` to use the current locale
+     */
     getLocaleForKey(groupName: string, key: string, locale?: string | null): string | null;
+    /**
+     * Returns the value associated with `key` under `group_name` translated in the given `locale` if available.
+     *
+     * If `locale` is `C` then the untranslated value is returned (since GLib 2.84).
+     *
+     * If `locale` is `NULL` then the current locale is assumed.
+     *
+     * If `locale` is to be non-`NULL`, or if the current locale will change over
+     * the lifetime of the [struct@GLib.KeyFile], it must be loaded with
+     * [flags@GLib.KeyFileFlags.KEEP_TRANSLATIONS] in order to load strings for all
+     * locales.
+     *
+     * If `key` cannot be found then [error@GLib.KeyFileError.KEY_NOT_FOUND] is
+     * returned. If the value associated
+     * with `key` cannot be interpreted or no suitable translation can
+     * be found then the untranslated value is returned.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param locale - a locale identifier or `NULL` to use the current locale
+     */
     getLocaleString(groupName: string, key: string, locale?: string | null): string;
+    /**
+     * Returns the values associated with `key` under `group_name` translated in the given `locale` if available.
+     *
+     * If `locale` is `C` then the untranslated value is returned (since GLib 2.84).
+     *
+     * If `locale` is `NULL` then the current locale is assumed.
+     *
+     * If `locale` is to be non-`NULL`, or if the current locale will change over
+     * the lifetime of the [struct@GLib.KeyFile], it must be loaded with
+     * [flags@GLib.KeyFileFlags.KEEP_TRANSLATIONS] in order to load strings for all
+     * locales.
+     *
+     * If `key` cannot be found then [error@GLib.KeyFileError.KEY_NOT_FOUND] is
+     * returned. If the values associated
+     * with `key` cannot be interpreted or no suitable translations
+     * can be found then the untranslated values are returned. The
+     * returned array is `NULL`-terminated, so `length` may optionally
+     * be `NULL`.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param locale - a locale identifier or `NULL` to use the current locale
+     * @param length - return location for the number of returned strings
+     */
     getLocaleStringList(groupName: string, key: string, locale?: string | null, length?: Ref<number> | null): string[];
+    /**
+     * Returns the name of the start group of the file.
+     */
     getStartGroup(): string | null;
+    /**
+     * Returns the string value associated with `key` under @group_name.
+     *
+     * Unlike [method@GLib.KeyFile.get_value], this function handles escape
+     * sequences like `\s`.
+     *
+     * If the key cannot be found, [error@GLib.KeyFileError.KEY_NOT_FOUND] is
+     * returned. If the `group_name` cannot be found,
+     * [error@GLib.KeyFileError.GROUP_NOT_FOUND] is returned.
+     * @param groupName - a group name
+     * @param key - a key
+     */
     getString(groupName: string, key: string): string;
+    /**
+     * Returns the values associated with `key` under @group_name.
+     *
+     * If the key cannot be found, [error@GLib.KeyFileError.KEY_NOT_FOUND] is
+     * returned. If the `group_name` cannot be found,
+     * [error@GLib.KeyFileError.GROUP_NOT_FOUND] is returned.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param length - return location for the number of returned
+     */
     getStringList(groupName: string, key: string, length?: Ref<number> | null): string[];
+    /**
+     * Returns the value associated with `key` under `group_name` as an unsigned
+     * 64-bit integer.
+     *
+     * This is similar to [method@GLib.KeyFile.get_integer] but can return
+     * large positive results without truncation.
+     * @param groupName - a group name
+     * @param key - a key
+     */
     getUint64(groupName: string, key: string): number;
+    /**
+     * Returns the raw value associated with `key` under @group_name.
+     *
+     * Use [method@GLib.KeyFile.get_string] to retrieve an unescaped UTF-8 string.
+     *
+     * If the key cannot be found, [error@GLib.KeyFileError.KEY_NOT_FOUND]
+     * is returned.  If the `group_name` cannot be found,
+     * [error@GLib.KeyFileError.GROUP_NOT_FOUND] is returned.
+     * @param groupName - a group name
+     * @param key - a key
+     */
     getValue(groupName: string, key: string): string;
+    /**
+     * Looks whether the key file has the group @group_name.
+     * @param groupName - a group name
+     */
     hasGroup(groupName: string): boolean;
+    /**
+     * Loads a key file from the data in `bytes` into an empty [struct@GLib.KeyFile]
+     * structure.
+     *
+     * If the object cannot be created then a [error@GLib.KeyFileError] is returned.
+     * @param bytes - a [struct@GLib.Bytes]
+     * @param flags - flags from [flags@GLib.KeyFileFlags]
+     */
     loadFromBytes(bytes: Bytes, flags: KeyFileFlags): boolean;
+    /**
+     * Loads a key file from memory into an empty [struct@GLib.KeyFile] structure.
+     *
+     * If the object cannot be created then a [error@GLib.KeyFileError is returned.
+     * @param data - key file loaded in memory
+     * @param length - the length of `data` in bytes (or `(gsize)-1` if data is nul-terminated)
+     * @param flags - flags from [flags@GLib.KeyFileFlags]
+     */
     loadFromData(data: string, length: number, flags: KeyFileFlags): boolean;
+    /**
+     * Looks for a key file named `file` in the paths returned from
+     * [func@GLib.get_user_data_dir] and [func@GLib.get_system_data_dirs].
+     *
+     * The search algorithm from [method@GLib.KeyFile.load_from_dirs] is used. If
+     * `file` is found, it’s loaded into `key_file` and its full path is returned in
+     * @full_path.
+     *
+     * If the file could not be loaded then either a [error@GLib.FileError] or
+     * [error@GLib.KeyFileError] is returned.
+     * @param file - a relative path to a filename to open and parse
+     * @param fullPath - return location for a string
+     * @param flags - flags from [flags@GLib.KeyFileFlags]
+     */
     loadFromDataDirs(file: string, flags: KeyFileFlags, fullPath?: Ref<string> | null): boolean;
+    /**
+     * Looks for a key file named `file` in the paths specified in @search_dirs,
+     * loads the file into `key_file` and returns the file’s full path in @full_path.
+     *
+     * `search_dirs` are checked in the order listed in the array, with the highest
+     * priority directory listed first. Within each directory, `file` is looked for.
+     * If it’s not found, `-` characters in `file` are progressively replaced with
+     * directory separators to search subdirectories of the search directory. If the
+     * file has not been found after all `-` characters have been replaced, the next
+     * search directory in `search_dirs` is checked.
+     *
+     * If the file could not be found in any of the @search_dirs,
+     * [error@GLib.KeyFileError.NOT_FOUND] is returned. If
+     * the file is found but the OS returns an error when opening or reading the
+     * file, a [error@GLib.FileError] is returned. If there is a problem parsing the
+     * file, a [error@GLib.KeyFileError] is returned.
+     * @param file - a relative path to a filename to open and parse
+     * @param searchDirs - `NULL`-terminated
+     * @param fullPath - return location for a string
+     * @param flags - flags from [flags@GLib.KeyFileFlags]
+     */
     loadFromDirs(file: string, searchDirs: string[], flags: KeyFileFlags, fullPath?: Ref<string> | null): boolean;
+    /**
+     * Loads a key file into an empty [struct@GLib.KeyFile] structure.
+     *
+     * If the OS returns an error when opening or reading the file, a
+     * [error@GLib.FileError] is returned. If there is a problem parsing the file,
+     * a [error@GLib.KeyFileError] is returned.
+     *
+     * This function will never return a [error@GLib.KeyFileError.NOT_FOUND]
+     * error. If the `file` is not found, [error@GLib.FileError.NOENT] is returned.
+     * @param file - the path of a filename to load, in the GLib filename encoding
+     * @param flags - flags from [flags@GLib.KeyFileFlags]
+     */
     loadFromFile(file: string, flags: KeyFileFlags): boolean;
+    /**
+     * Removes a comment above `key` from @group_name.
+     *
+     * If `key` is `NULL` then `comment` will be removed above @group_name.
+     * If both `key` and `group_name` are `NULL`, then `comment` will
+     * be removed above the first group in the file.
+     * @param groupName - a group name, or `NULL` to get a top-level comment
+     * @param key - a key, or `NULL` to get a group comment
+     */
     removeComment(groupName?: string | null, key?: string | null): boolean;
+    /**
+     * Removes the specified group, @group_name,
+     * from the key file.
+     * @param groupName - a group name
+     */
     removeGroup(groupName: string): boolean;
+    /**
+     * Removes `key` in `group_name` from the key file.
+     * @param groupName - a group name
+     * @param key - a key name to remove
+     */
     removeKey(groupName: string, key: string): boolean;
+    /**
+     * Writes the contents of `key_file` to `filename` using
+     * [func@GLib.file_set_contents].
+     *
+     * If you need stricter guarantees about durability of
+     * the written file than are provided by [func@GLib.file_set_contents], use
+     * [func@GLib.file_set_contents_full] with the return value of
+     * [method@GLib.KeyFile.to_data].
+     *
+     * This function can fail for any of the reasons that
+     * [func@GLib.file_set_contents] may fail.
+     * @param filename - the name of the file to write to
+     */
     saveToFile(filename: string): boolean;
+    /**
+     * Associates a new boolean value with `key` under @group_name.
+     *
+     * If `key` cannot be found then it is created.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param value - true or false
+     */
     setBoolean(groupName: string, key: string, value: boolean): void;
+    /**
+     * Associates a list of boolean values with `key` under @group_name.
+     *
+     * If `key` cannot be found then it is created.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param list - an array of boolean values
+     * @param length - length of @list
+     */
     setBooleanList(groupName: string, key: string, list: boolean[], length: number): void;
+    /**
+     * Places a comment above `key` from @group_name.
+     *
+     * If `key` is `NULL` then `comment` will be written above @group_name.
+     * If both `key` and `group_name` are `NULL`, then `comment` will be
+     * written above the first group in the file.
+     *
+     * Passing a non-existent `group_name` or `key` to this function returns
+     * false and populates @error. (In contrast, passing a non-existent
+     * `group_name` or `key` to [method@GLib.KeyFile.set_string]
+     * creates the associated group name and key.)
+     *
+     * Note that this function prepends a `#` comment marker to
+     * each line of @comment.
+     * @param groupName - a group name, or `NULL` to write a top-level comment
+     * @param key - a key, or `NULL` to write a group comment
+     * @param comment - a comment
+     */
     setComment(comment: string, groupName?: string | null, key?: string | null): boolean;
+    /**
+     * Associates a new double value with `key` under @group_name.
+     *
+     * If `key` cannot be found then it is created.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param value - a double value
+     */
     setDouble(groupName: string, key: string, value: number): void;
+    /**
+     * Associates a list of double values with `key` under @group_name.
+     *
+     * If `key` cannot be found then it is created.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param list - an array of double values
+     * @param length - number of double values in @list
+     */
     setDoubleList(groupName: string, key: string, list: number[], length: number): void;
+    /**
+     * Associates a new integer value with `key` under @group_name.
+     *
+     * If `key` cannot be found then it is created.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param value - an integer value
+     */
     setInt64(groupName: string, key: string, value: number): void;
+    /**
+     * Associates a new integer value with `key` under @group_name.
+     *
+     * If `key` cannot be found then it is created.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param value - an integer value
+     */
     setInteger(groupName: string, key: string, value: number): void;
+    /**
+     * Associates a list of integer values with `key` under @group_name.
+     *
+     * If `key` cannot be found then it is created.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param list - an array of integer values
+     * @param length - number of integer values in @list
+     */
     setIntegerList(groupName: string, key: string, list: number[], length: number): void;
+    /**
+     * Sets the character which is used to separate values in lists.
+     *
+     * Typically `;` or `,` are used as separators. The default list separator
+     * is `;`.
+     * @param separator - the separator
+     */
     setListSeparator(separator: number): void;
+    /**
+     * Associates a string value for `key` and `locale` under @group_name.
+     *
+     * If the translation for `key` cannot be found then it is created.
+     *
+     * If `locale` is `C` then the untranslated value is set (since GLib 2.84).
+     * @param groupName - a group name
+     * @param key - a key
+     * @param locale - a locale identifier
+     * @param string - a string
+     */
     setLocaleString(groupName: string, key: string, locale: string, string: string): void;
+    /**
+     * Associates a list of string values for `key` and `locale` under
+     * @group_name.
+     *
+     * If `locale` is `C` then the untranslated value is set (since GLib 2.84).
+     *
+     * If the translation for `key` cannot be found then it is created.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param locale - a locale identifier
+     * @param list - a `NULL`-terminated array of
+     * @param length - the length of @list
+     */
     setLocaleStringList(groupName: string, key: string, locale: string, list: string[], length: number): void;
+    /**
+     * Associates a new string value with `key` under @group_name.
+     *
+     * If `key` cannot be found then it is created.
+     * If `group_name` cannot be found then it is created.
+     * Unlike [method@GLib.KeyFile.set_value], this function handles characters
+     * that need escaping, such as newlines.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param string - a string
+     */
     setString(groupName: string, key: string, string: string): void;
+    /**
+     * Associates a list of string values for `key` under @group_name.
+     *
+     * If `key` cannot be found then it is created.
+     * If `group_name` cannot be found then it is created.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param list - an array
+     * @param length - number of string values in @list
+     */
     setStringList(groupName: string, key: string, list: string[], length: number): void;
+    /**
+     * Associates a new integer value with `key` under @group_name.
+     *
+     * If `key` cannot be found then it is created.
+     * @param groupName - a group name
+     * @param key - a key
+     * @param value - an integer value
+     */
     setUint64(groupName: string, key: string, value: number): void;
+    /**
+     * Associates a new value with `key` under @group_name.
+     *
+     * If `key` cannot be found then it is created. If `group_name` cannot
+     * be found then it is created. To set an UTF-8 string which may contain
+     * characters that need escaping (such as newlines or spaces), use
+     * [method@GLib.KeyFile.set_string].
+     * @param groupName - a group name
+     * @param key - a key
+     * @param value - a string
+     */
     setValue(groupName: string, key: string, value: string): void;
+    /**
+     * Outputs `key_file` as a string.
+     *
+     * Note that this function never reports an error.
+     * @param length - return location for the length of the
+     */
     toData(length?: Ref<number> | null): string;
+    /**
+     * Decreases the reference count of `key_file` by 1.
+     *
+     * If the reference count reaches zero, frees the key file and all its allocated
+     * memory.
+     */
     unref(): void;
 }