@gtkx/ffi 0.1.45 → 0.1.46

package/dist/generated/glib/bookmark-file.js

@@ -1,8 +1,54 @@
 import { call } from "@gtkx/native";
 import { NativeError, getObject } from "@gtkx/ffi";
 import { DateTime } from "./date-time.js";
+/**
+ * `GBookmarkFile` lets you parse, edit or create files containing bookmarks.
+ *
+ * Bookmarks refer to a URI, along with some meta-data about the resource
+ * pointed by the URI like its MIME type, the application that is registering
+ * the bookmark and the icon that should be used to represent the bookmark.
+ * The data is stored using the
+ * [Desktop Bookmark Specification](https://www.freedesktop.org/wiki/Specifications/desktop-bookmark-spec/).
+ *
+ * The syntax of the bookmark files is described in detail inside the
+ * Desktop Bookmark Specification, here is a quick summary: bookmark
+ * files use a sub-class of the XML Bookmark Exchange Language
+ * specification, consisting of valid UTF-8 encoded XML, under the
+ * `<xbel>` root element; each bookmark is stored inside a
+ * `<bookmark>` element, using its URI: no relative paths can
+ * be used inside a bookmark file. The bookmark may have a user defined
+ * title and description, to be used instead of the URI. Under the
+ * `<metadata>` element, with its owner attribute set to
+ * `http://freedesktop.org`, is stored the meta-data about a resource
+ * pointed by its URI. The meta-data consists of the resource's MIME
+ * type; the applications that have registered a bookmark; the groups
+ * to which a bookmark belongs to; a visibility flag, used to set the
+ * bookmark as "private" to the applications and groups that has it
+ * registered; the URI and MIME type of an icon, to be used when
+ * displaying the bookmark inside a GUI.
+ *
+ * Here is an example of a bookmark file:
+ * [bookmarks.xbel](https://gitlab.gnome.org/GNOME/glib/-/blob/HEAD/glib/tests/bookmarks.xbel)
+ *
+ * A bookmark file might contain more than one bookmark; each bookmark
+ * is accessed through its URI.
+ *
+ * The important caveat of bookmark files is that when you add a new
+ * bookmark you must also add the application that is registering it, using
+ * [method@GLib.BookmarkFile.add_application] or [method@GLib.BookmarkFile.set_application_info].
+ * If a bookmark has no applications then it won't be dumped when creating
+ * the on disk representation, using [method@GLib.BookmarkFile.to_data] or
+ * [method@GLib.BookmarkFile.to_file].
+ */
 export class BookmarkFile {
     ptr;
+    /**
+     * Creates a new empty #GBookmarkFile object.
+     *
+     * Use g_bookmark_file_load_from_file(), g_bookmark_file_load_from_data()
+     * or g_bookmark_file_load_from_data_dirs() to read an existing bookmark
+     * file.
+     */
     constructor() {
         this.ptr = this.createPtr([]);
     }
@@ -12,6 +58,33 @@ export class BookmarkFile {
     static errorQuark() {
         return call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_error_quark", [], { type: "int", size: 32, unsigned: true });
     }
+    /**
+     * Adds the application with `name` and `exec` to the list of
+     * applications that have registered a bookmark for `uri` into
+     * @bookmark.
+     *
+     * Every bookmark inside a #GBookmarkFile must have at least an
+     * application registered.  Each application must provide a name, a
+     * command line useful for launching the bookmark, the number of times
+     * the bookmark has been registered by the application and the last
+     * time the application registered this bookmark.
+     *
+     * If `name` is %NULL, the name of the application will be the
+     * same returned by g_get_application_name(); if `exec` is %NULL, the
+     * command line will be a composition of the program name as
+     * returned by g_get_prgname() and the "\%u" modifier, which will be
+     * expanded to the bookmark's URI.
+     *
+     * This function will automatically take care of updating the
+     * registrations count and timestamping in case an application
+     * with the same `name` had already registered a bookmark for
+     * `uri` inside @bookmark.
+     *
+     * If no bookmark for `uri` is found, one is created.
+     * @param uri - a valid URI
+     * @param name - the name of the application registering the bookmark
+     * @param exec - command line to be used to launch the bookmark or %NULL
+     */
     addApplication(uri, name, exec) {
         call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_add_application", [
             {
@@ -34,6 +107,13 @@ export class BookmarkFile {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Adds `group` to the list of groups to which the bookmark for `uri` belongs to.
+     *
+     * If no bookmark for `uri` is found then it is created.
+     * @param uri - a valid URI
+     * @param group - the group name to be added
+     */
     addGroup(uri, group) {
         call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_add_group", [
             {
@@ -50,6 +130,9 @@ export class BookmarkFile {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Deeply copies a `bookmark` #GBookmarkFile object to a new one.
+     */
     copy() {
         const ptr = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_copy", [
             {
@@ -64,6 +147,9 @@ export class BookmarkFile {
         });
         return getObject(ptr, BookmarkFile);
     }
+    /**
+     * Frees a #GBookmarkFile.
+     */
     free() {
         call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_free", [
             {
@@ -72,6 +158,12 @@ export class BookmarkFile {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Gets the time the bookmark for `uri` was added to `bookmark`
+     * In the event the URI cannot be found, -1 is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     */
     getAdded(uri) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_added", [
@@ -100,6 +192,12 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Gets the time the bookmark for `uri` was added to `bookmark`
+     * In the event the URI cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     */
     getAddedDateTime(uri) {
         const error = { value: null };
         const ptr = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_added_date_time", [
@@ -133,6 +231,26 @@ export class BookmarkFile {
         }
         return getObject(ptr, DateTime);
     }
+    /**
+     * Gets the registration information of `app_name` for the bookmark for
+     * @uri.  See g_bookmark_file_set_application_info() for more information about
+     * the returned data.
+     *
+     * The string returned in `app_exec` must be freed.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.  In the
+     * event that no application with name `app_name` has registered a bookmark
+     * for @uri,  %FALSE is returned and error is set to
+     * %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. In the event that unquoting
+     * the command line fails, an error of the %G_SHELL_ERROR domain is
+     * set and %FALSE is returned.
+     * @param uri - a valid URI
+     * @param name - an application's name
+     * @param exec - return location for the command line of the application, or %NULL
+     * @param count - return location for the registration count, or %NULL
+     * @param stamp - return location for the last registration time, or %NULL
+     */
     getAppInfo(uri, name, exec, count, stamp) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_app_info", [
@@ -186,6 +304,26 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Gets the registration information of `app_name` for the bookmark for
+     * @uri.  See g_bookmark_file_set_application_info() for more information about
+     * the returned data.
+     *
+     * The string returned in `app_exec` must be freed.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.  In the
+     * event that no application with name `app_name` has registered a bookmark
+     * for @uri,  %FALSE is returned and error is set to
+     * %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED. In the event that unquoting
+     * the command line fails, an error of the %G_SHELL_ERROR domain is
+     * set and %FALSE is returned.
+     * @param uri - a valid URI
+     * @param name - an application's name
+     * @param exec - return location for the command line of the application, or %NULL
+     * @param count - return location for the registration count, or %NULL
+     * @param stamp - return location for the last registration time, or %NULL
+     */
     getApplicationInfo(uri, name, exec, count, stamp) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_application_info", [
@@ -243,6 +381,15 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Retrieves the names of the applications that have registered the
+     * bookmark for @uri.
+     *
+     * In the event the URI cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     * @param length - return location of the length of the returned list, or %NULL
+     */
     getApplications(uri, length) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_applications", [
@@ -279,6 +426,13 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Retrieves the description of the bookmark for @uri.
+     *
+     * In the event the URI cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     */
     getDescription(uri) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_description", [
@@ -307,6 +461,17 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Retrieves the list of group names of the bookmark for @uri.
+     *
+     * In the event the URI cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     *
+     * The returned array is %NULL terminated, so `length` may optionally
+     * be %NULL.
+     * @param uri - a valid URI
+     * @param length - return location for the length of the returned string, or %NULL
+     */
     getGroups(uri, length) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_groups", [
@@ -343,6 +508,15 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Gets the icon of the bookmark for @uri.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     * @param href - return location for the icon's location or %NULL
+     * @param mimeType - return location for the icon's MIME type or %NULL
+     */
     getIcon(uri, href, mimeType) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_icon", [
@@ -381,6 +555,15 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Gets whether the private flag of the bookmark for `uri` is set.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.  In the
+     * event that the private flag cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
+     * @param uri - a valid URI
+     */
     getIsPrivate(uri) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_is_private", [
@@ -409,6 +592,15 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Retrieves the MIME type of the resource pointed by @uri.
+     *
+     * In the event the URI cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.  In the
+     * event that the MIME type cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
+     * @param uri - a valid URI
+     */
     getMimeType(uri) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_mime_type", [
@@ -437,6 +629,13 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Gets the time when the bookmark for `uri` was last modified.
+     *
+     * In the event the URI cannot be found, -1 is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     */
     getModified(uri) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_modified", [
@@ -465,6 +664,13 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Gets the time when the bookmark for `uri` was last modified.
+     *
+     * In the event the URI cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     */
     getModifiedDateTime(uri) {
         const error = { value: null };
         const ptr = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_modified_date_time", [
@@ -498,6 +704,9 @@ export class BookmarkFile {
         }
         return getObject(ptr, DateTime);
     }
+    /**
+     * Gets the number of bookmarks inside @bookmark.
+     */
     getSize() {
         return call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_size", [
             {
@@ -506,6 +715,15 @@ export class BookmarkFile {
             },
         ], { type: "int", size: 32, unsigned: false });
     }
+    /**
+     * Returns the title of the bookmark for @uri.
+     *
+     * If `uri` is %NULL, the title of `bookmark` is returned.
+     *
+     * In the event the URI cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI or %NULL
+     */
     getTitle(uri) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_title", [
@@ -535,6 +753,12 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Returns all URIs of the bookmarks in the bookmark file @bookmark.
+     * The array of returned URIs will be %NULL-terminated, so `length` may
+     * optionally be %NULL.
+     * @param length - return location for the number of returned URIs, or %NULL
+     */
     getUris(length) {
         return call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_uris", [
             {
@@ -551,6 +775,13 @@ export class BookmarkFile {
             },
         ], { type: "array", itemType: { type: "string" } });
     }
+    /**
+     * Gets the time the bookmark for `uri` was last visited.
+     *
+     * In the event the URI cannot be found, -1 is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     */
     getVisited(uri) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_visited", [
@@ -579,6 +810,13 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Gets the time the bookmark for `uri` was last visited.
+     *
+     * In the event the URI cannot be found, %NULL is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     */
     getVisitedDateTime(uri) {
         const error = { value: null };
         const ptr = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_get_visited_date_time", [
@@ -612,6 +850,15 @@ export class BookmarkFile {
         }
         return getObject(ptr, DateTime);
     }
+    /**
+     * Checks whether the bookmark for `uri` inside `bookmark` has been
+     * registered by application @name.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     * @param name - the name of the application
+     */
     hasApplication(uri, name) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_has_application", [
@@ -644,6 +891,15 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Checks whether `group` appears in the list of groups to which
+     * the bookmark for `uri` belongs to.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param uri - a valid URI
+     * @param group - the group name to be searched
+     */
     hasGroup(uri, group) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_has_group", [
@@ -676,6 +932,10 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Looks whether the desktop bookmark has an item with its URI set to @uri.
+     * @param uri - a valid URI
+     */
     hasItem(uri) {
         return call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_has_item", [
             {
@@ -688,6 +948,13 @@ export class BookmarkFile {
             },
         ], { type: "boolean" });
     }
+    /**
+     * Loads a bookmark file from memory into an empty #GBookmarkFile
+     * structure.  If the object cannot be created then `error` is set to a
+     * #GBookmarkFileError.
+     * @param data - desktop bookmarks
+     * @param length - the length of `data` in bytes
+     */
     loadFromData(data, length) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_load_from_data", [
@@ -723,6 +990,15 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * This function looks for a desktop bookmark file named `file` in the
+     * paths returned from g_get_user_data_dir() and g_get_system_data_dirs(),
+     * loads the file into `bookmark` and returns the file's full path in
+     * @full_path.  If the file could not be loaded then `error` is
+     * set to either a #GFileError or #GBookmarkFileError.
+     * @param file - a relative path to a filename to open and parse
+     * @param fullPath - return location for a string
+     */
     loadFromDataDirs(file, fullPath) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_load_from_data_dirs", [
@@ -756,6 +1032,12 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Loads a desktop bookmark file into an empty #GBookmarkFile structure.
+     * If the file could not be loaded then `error` is set to either a #GFileError
+     * or #GBookmarkFileError.
+     * @param filename - the path of a filename to load, in the
+     */
     loadFromFile(filename) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_load_from_file", [
@@ -784,6 +1066,16 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Changes the URI of a bookmark item from `old_uri` to @new_uri.  Any
+     * existing bookmark for `new_uri` will be overwritten.  If `new_uri` is
+     * %NULL, then the bookmark is removed.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * @param oldUri - a valid URI
+     * @param newUri - a valid URI, or %NULL
+     */
     moveItem(oldUri, newUri) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_move_item", [
@@ -817,6 +1109,18 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Removes application registered with `name` from the list of applications
+     * that have registered a bookmark for `uri` inside @bookmark.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * In the event that no application with name `app_name` has registered
+     * a bookmark for @uri,  %FALSE is returned and error is set to
+     * %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.
+     * @param uri - a valid URI
+     * @param name - the name of the application
+     */
     removeApplication(uri, name) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_remove_application", [
@@ -849,6 +1153,17 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Removes `group` from the list of groups to which the bookmark
+     * for `uri` belongs to.
+     *
+     * In the event the URI cannot be found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND.
+     * In the event no group was defined, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_INVALID_VALUE.
+     * @param uri - a valid URI
+     * @param group - the group name to be removed
+     */
     removeGroup(uri, group) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_remove_group", [
@@ -881,6 +1196,10 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Removes the bookmark for `uri` from the bookmark file @bookmark.
+     * @param uri - a valid URI
+     */
     removeItem(uri) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_remove_item", [
@@ -909,6 +1228,13 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Sets the time the bookmark for `uri` was added into @bookmark.
+     *
+     * If no bookmark for `uri` is found then it is created.
+     * @param uri - a valid URI
+     * @param added - a timestamp or -1 to use the current time
+     */
     setAdded(uri, added) {
         call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_set_added", [
             {
@@ -925,6 +1251,13 @@ export class BookmarkFile {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the time the bookmark for `uri` was added into @bookmark.
+     *
+     * If no bookmark for `uri` is found then it is created.
+     * @param uri - a valid URI
+     * @param added - a #GDateTime
+     */
     setAddedDateTime(uri, added) {
         call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_set_added_date_time", [
             {
@@ -946,6 +1279,41 @@ export class BookmarkFile {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the meta-data of application `name` inside the list of
+     * applications that have registered a bookmark for `uri` inside
+     * @bookmark.
+     *
+     * You should rarely use this function; use g_bookmark_file_add_application()
+     * and g_bookmark_file_remove_application() instead.
+     *
+     * `name` can be any UTF-8 encoded string used to identify an
+     * application.
+     * `exec` can have one of these two modifiers: "\%f", which will
+     * be expanded as the local file name retrieved from the bookmark's
+     * URI; "\%u", which will be expanded as the bookmark's URI.
+     * The expansion is done automatically when retrieving the stored
+     * command line using the g_bookmark_file_get_application_info() function.
+     * `count` is the number of times the application has registered the
+     * bookmark; if is < 0, the current registration count will be increased
+     * by one, if is 0, the application with `name` will be removed from
+     * the list of registered applications.
+     * `stamp` is the Unix time of the last registration; if it is -1, the
+     * current time will be used.
+     *
+     * If you try to remove an application by setting its registration count to
+     * zero, and no bookmark for `uri` is found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND; similarly,
+     * in the event that no application `name` has registered a bookmark
+     * for @uri,  %FALSE is returned and error is set to
+     * %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.  Otherwise, if no bookmark
+     * for `uri` is found, one is created.
+     * @param uri - a valid URI
+     * @param name - an application's name
+     * @param exec - an application's command line
+     * @param count - the number of registrations done for this application
+     * @param stamp - the time of the last registration for this application
+     */
     setAppInfo(uri, name, exec, count, stamp) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_set_app_info", [
@@ -990,6 +1358,40 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Sets the meta-data of application `name` inside the list of
+     * applications that have registered a bookmark for `uri` inside
+     * @bookmark.
+     *
+     * You should rarely use this function; use g_bookmark_file_add_application()
+     * and g_bookmark_file_remove_application() instead.
+     *
+     * `name` can be any UTF-8 encoded string used to identify an
+     * application.
+     * `exec` can have one of these two modifiers: "\%f", which will
+     * be expanded as the local file name retrieved from the bookmark's
+     * URI; "\%u", which will be expanded as the bookmark's URI.
+     * The expansion is done automatically when retrieving the stored
+     * command line using the g_bookmark_file_get_application_info() function.
+     * `count` is the number of times the application has registered the
+     * bookmark; if is < 0, the current registration count will be increased
+     * by one, if is 0, the application with `name` will be removed from
+     * the list of registered applications.
+     * `stamp` is the Unix time of the last registration.
+     *
+     * If you try to remove an application by setting its registration count to
+     * zero, and no bookmark for `uri` is found, %FALSE is returned and
+     * `error` is set to %G_BOOKMARK_FILE_ERROR_URI_NOT_FOUND; similarly,
+     * in the event that no application `name` has registered a bookmark
+     * for @uri,  %FALSE is returned and error is set to
+     * %G_BOOKMARK_FILE_ERROR_APP_NOT_REGISTERED.  Otherwise, if no bookmark
+     * for `uri` is found, one is created.
+     * @param uri - a valid URI
+     * @param name - an application's name
+     * @param exec - an application's command line
+     * @param count - the number of registrations done for this application
+     * @param stamp - the time of the last registration for this application,
+     */
     setApplicationInfo(uri, name, exec, count, stamp) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_set_application_info", [
@@ -1040,6 +1442,15 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * Sets `description` as the description of the bookmark for @uri.
+     *
+     * If `uri` is %NULL, the description of `bookmark` is set.
+     *
+     * If a bookmark for `uri` cannot be found then it is created.
+     * @param uri - a valid URI or %NULL
+     * @param description - a string
+     */
     setDescription(description, uri) {
         call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_set_description", [
             {
@@ -1057,6 +1468,15 @@ export class BookmarkFile {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets a list of group names for the item with URI @uri.  Each previously
+     * set group name list is removed.
+     *
+     * If `uri` cannot be found then an item for it is created.
+     * @param uri - an item's URI
+     * @param groups - an array of
+     * @param length - number of group name values in @groups
+     */
     setGroups(uri, length, groups) {
         call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_set_groups", [
             {
@@ -1078,6 +1498,16 @@ export class BookmarkFile {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the icon for the bookmark for @uri. If `href` is %NULL, unsets
+     * the currently set icon. `href` can either be a full URL for the icon
+     * file or the icon name following the Icon Naming specification.
+     *
+     * If no bookmark for `uri` is found one is created.
+     * @param uri - a valid URI
+     * @param href - the URI of the icon for the bookmark, or %NULL
+     * @param mimeType - the MIME type of the icon for the bookmark
+     */
     setIcon(uri, mimeType, href) {
         call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_set_icon", [
             {
@@ -1099,6 +1529,13 @@ export class BookmarkFile {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the private flag of the bookmark for @uri.
+     *
+     * If a bookmark for `uri` cannot be found then it is created.
+     * @param uri - a valid URI
+     * @param isPrivate - %TRUE if the bookmark should be marked as private
+     */
     setIsPrivate(uri, isPrivate) {
         call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_set_is_private", [
             {
@@ -1115,6 +1552,13 @@ export class BookmarkFile {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets `mime_type` as the MIME type of the bookmark for @uri.
+     *
+     * If a bookmark for `uri` cannot be found then it is created.
+     * @param uri - a valid URI
+     * @param mimeType - a MIME type
+     */
     setMimeType(uri, mimeType) {
         call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_set_mime_type", [
             {
@@ -1131,6 +1575,18 @@ export class BookmarkFile {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the last time the bookmark for `uri` was last modified.
+     *
+     * If no bookmark for `uri` is found then it is created.
+     *
+     * The "modified" time should only be set when the bookmark's meta-data
+     * was actually changed.  Every function of #GBookmarkFile that
+     * modifies a bookmark also changes the modification time, except for
+     * g_bookmark_file_set_visited_date_time().
+     * @param uri - a valid URI
+     * @param modified - a timestamp or -1 to use the current time
+     */
     setModified(uri, modified) {
         call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_set_modified", [
             {
@@ -1147,6 +1603,18 @@ export class BookmarkFile {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the last time the bookmark for `uri` was last modified.
+     *
+     * If no bookmark for `uri` is found then it is created.
+     *
+     * The "modified" time should only be set when the bookmark's meta-data
+     * was actually changed.  Every function of #GBookmarkFile that
+     * modifies a bookmark also changes the modification time, except for
+     * g_bookmark_file_set_visited_date_time().
+     * @param uri - a valid URI
+     * @param modified - a #GDateTime
+     */
     setModifiedDateTime(uri, modified) {
         call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_set_modified_date_time", [
             {
@@ -1168,6 +1636,16 @@ export class BookmarkFile {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets `title` as the title of the bookmark for `uri` inside the
+     * bookmark file @bookmark.
+     *
+     * If `uri` is %NULL, the title of `bookmark` is set.
+     *
+     * If a bookmark for `uri` cannot be found then it is created.
+     * @param uri - a valid URI or %NULL
+     * @param title - a UTF-8 encoded string
+     */
     setTitle(title, uri) {
         call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_set_title", [
             {
@@ -1185,6 +1663,19 @@ export class BookmarkFile {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the time the bookmark for `uri` was last visited.
+     *
+     * If no bookmark for `uri` is found then it is created.
+     *
+     * The "visited" time should only be set if the bookmark was launched,
+     * either using the command line retrieved by g_bookmark_file_get_application_info()
+     * or by the default application for the bookmark's MIME type, retrieved
+     * using g_bookmark_file_get_mime_type().  Changing the "visited" time
+     * does not affect the "modified" time.
+     * @param uri - a valid URI
+     * @param visited - a timestamp or -1 to use the current time
+     */
     setVisited(uri, visited) {
         call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_set_visited", [
             {
@@ -1201,6 +1692,19 @@ export class BookmarkFile {
             },
         ], { type: "undefined" });
     }
+    /**
+     * Sets the time the bookmark for `uri` was last visited.
+     *
+     * If no bookmark for `uri` is found then it is created.
+     *
+     * The "visited" time should only be set if the bookmark was launched,
+     * either using the command line retrieved by g_bookmark_file_get_application_info()
+     * or by the default application for the bookmark's MIME type, retrieved
+     * using g_bookmark_file_get_mime_type().  Changing the "visited" time
+     * does not affect the "modified" time.
+     * @param uri - a valid URI
+     * @param visited - a #GDateTime
+     */
     setVisitedDateTime(uri, visited) {
         call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_set_visited_date_time", [
             {
@@ -1222,6 +1726,10 @@ export class BookmarkFile {
             },
         ], { type: "undefined" });
     }
+    /**
+     * This function outputs `bookmark` as a string.
+     * @param length - return location for the length of the returned string, or %NULL
+     */
     toData(length) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_to_data", [
@@ -1254,6 +1762,11 @@ export class BookmarkFile {
         }
         return result;
     }
+    /**
+     * This function outputs `bookmark` into a file.  The write process is
+     * guaranteed to be atomic by using g_file_set_contents() internally.
+     * @param filename - path of the output file
+     */
     toFile(filename) {
         const error = { value: null };
         const result = call("libgobject-2.0.so.0,libglib-2.0.so.0", "g_bookmark_file_to_file", [