[gnome-software] trivial: Add 'Since' tags to the exported API
- From: Richard Hughes <rhughes src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-software] trivial: Add 'Since' tags to the exported API
- Date: Fri, 12 Aug 2016 07:38:37 +0000 (UTC)
commit 539a32063a91aa5a6c8e9190d72cdfd4cf94c8f1
Author: Richard Hughes <richard hughsie com>
Date: Fri Aug 12 08:36:05 2016 +0100
trivial: Add 'Since' tags to the exported API
src/gs-app-list.c | 20 +++++
src/gs-app.c | 232 +++++++++++++++++++++++++++++++++++++++++++++++++++
src/gs-category.c | 44 ++++++++++
src/gs-os-release.c | 14 +++
src/gs-plugin.c | 84 ++++++++++++++++++
5 files changed, 394 insertions(+), 0 deletions(-)
---
diff --git a/src/gs-app-list.c b/src/gs-app-list.c
index ee19b29..c9618e4 100644
--- a/src/gs-app-list.c
+++ b/src/gs-app-list.c
@@ -57,6 +57,8 @@ G_DEFINE_TYPE (GsAppList, gs_app_list, G_TYPE_OBJECT)
* Applications that have the application ID lazy-loaded will always be addded
* to the list, and to clean these up the plugin loader will also call the
* gs_app_list_filter_duplicates() method when all plugins have run.
+ *
+ * Since: 3.22
**/
void
gs_app_list_add (GsAppList *list, GsApp *app)
@@ -105,6 +107,8 @@ gs_app_list_add (GsAppList *list, GsApp *app)
* Gets an application at a specific position in the list.
*
* Returns: (transfer none): a #GsApp, or %NULL if invalid
+ *
+ * Since: 3.22
**/
GsApp *
gs_app_list_index (GsAppList *list, guint idx)
@@ -119,6 +123,8 @@ gs_app_list_index (GsAppList *list, guint idx)
* Gets the length of the application list.
*
* Returns: Integer
+ *
+ * Since: 3.22
**/
guint
gs_app_list_length (GsAppList *list)
@@ -132,6 +138,8 @@ gs_app_list_length (GsAppList *list)
* @list: A #GsAppList
*
* Removes all applications from the list.
+ *
+ * Since: 3.22
**/
void
gs_app_list_remove_all (GsAppList *list)
@@ -148,6 +156,8 @@ gs_app_list_remove_all (GsAppList *list)
* @user_data: the user pointer to pass to @func
*
* If func() returns TRUE for the GsApp, then the app is kept.
+ *
+ * Since: 3.22
**/
void
gs_app_list_filter (GsAppList *list, GsAppListFilterFunc func, gpointer user_data)
@@ -191,6 +201,8 @@ gs_app_list_sort_cb (gconstpointer a, gconstpointer b, gpointer user_data)
* @func: A #GCompareFunc
*
* Sorts the application list.
+ *
+ * Since: 3.22
**/
void
gs_app_list_sort (GsAppList *list, GsAppListSortFunc func, gpointer user_data)
@@ -223,6 +235,8 @@ gs_app_list_randomize_cb (gconstpointer a, gconstpointer b, gpointer user_data)
*
* Randomize the order of the list, but don't change the order until
* the next day.
+ *
+ * Since: 3.22
**/
void
gs_app_list_randomize (GsAppList *list)
@@ -260,6 +274,8 @@ gs_app_list_randomize (GsAppList *list)
* @list: A #GsAppList
*
* Filter any duplicate applications from the list.
+ *
+ * Since: 3.22
**/
void
gs_app_list_filter_duplicates (GsAppList *list, GsAppListFilterFlags flags)
@@ -335,6 +351,8 @@ gs_app_list_filter_duplicates (GsAppList *list, GsAppListFilterFlags flags)
* Returns a deep copy of the application list.
*
* Returns: A newly allocated #GsAppList
+ *
+ * Since: 3.22
**/
GsAppList *
gs_app_list_copy (GsAppList *list)
@@ -381,6 +399,8 @@ gs_app_list_init (GsAppList *list)
* Creates a new list.
*
* Returns: A newly allocated #GsAppList
+ *
+ * Since: 3.22
**/
GsAppList *
gs_app_list_new (void)
diff --git a/src/gs-app.c b/src/gs-app.c
index 7f38225..e8e67cc 100644
--- a/src/gs-app.c
+++ b/src/gs-app.c
@@ -231,6 +231,8 @@ _as_app_quirk_to_string (AsAppQuirk quirk)
* for debugging.
*
* Returns: A multi-line string
+ *
+ * Since: 3.22
**/
gchar *
gs_app_to_string (GsApp *app)
@@ -502,6 +504,8 @@ gs_app_queue_notify (GsApp *app, const gchar *property_name)
* Gets the application ID.
*
* Returns: The whole ID, e.g. "gimp.desktop"
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_id (GsApp *app)
@@ -544,6 +548,8 @@ gs_app_set_id (GsApp *app, const gchar *id)
* Gets the scope of the application.
*
* Returns: the #AsAppScope, e.g. %AS_APP_SCOPE_USER
+ *
+ * Since: 3.22
**/
AsAppScope
gs_app_get_scope (GsApp *app)
@@ -558,6 +564,8 @@ gs_app_get_scope (GsApp *app)
* @scope: a #AsAppScope, e.g. AS_APP_SCOPE_SYSTEM
*
* This sets the scope of the application.
+ *
+ * Since: 3.22
**/
void
gs_app_set_scope (GsApp *app, AsAppScope scope)
@@ -576,6 +584,8 @@ gs_app_set_scope (GsApp *app, AsAppScope scope)
* Gets the bundle kind of the application.
*
* Returns: the #AsAppScope, e.g. %AS_BUNDLE_KIND_FLATPAK
+ *
+ * Since: 3.22
**/
AsBundleKind
gs_app_get_bundle_kind (GsApp *app)
@@ -590,6 +600,8 @@ gs_app_get_bundle_kind (GsApp *app)
* @bundle_kind: a #AsAppScope, e.g. AS_BUNDLE_KIND_FLATPAK
*
* This sets the bundle kind of the application.
+ *
+ * Since: 3.22
**/
void
gs_app_set_bundle_kind (GsApp *app, AsBundleKind bundle_kind)
@@ -608,6 +620,8 @@ gs_app_set_bundle_kind (GsApp *app, AsBundleKind bundle_kind)
* Gets the state of the application.
*
* Returns: the #AsAppState, e.g. %AS_APP_STATE_INSTALLED
+ *
+ * Since: 3.22
**/
AsAppState
gs_app_get_state (GsApp *app)
@@ -623,6 +637,8 @@ gs_app_get_state (GsApp *app)
* Gets the percentage completion.
*
* Returns: the percentage completion, or 0 for unknown
+ *
+ * Since: 3.22
**/
guint
gs_app_get_progress (GsApp *app)
@@ -637,6 +653,8 @@ gs_app_get_progress (GsApp *app)
*
* Sets the application state to the last status value that was not
* transient.
+ *
+ * Since: 3.22
**/
void
gs_app_set_state_recover (GsApp *app)
@@ -787,6 +805,8 @@ gs_app_set_state_internal (GsApp *app, AsAppState state)
* This sets the progress completion of the application.
* If called more than once with the same value then subsequent calls
* will be ignored.
+ *
+ * Since: 3.22
**/
void
gs_app_set_progress (GsApp *app, guint percentage)
@@ -819,6 +839,8 @@ gs_app_set_progress (GsApp *app, guint percentage)
* AVAILABLE <--> QUEUED --> INSTALLING --> INSTALLED
* UNKNOWN --> UNAVAILABLE
* ]|
+ *
+ * Since: 3.22
**/
void
gs_app_set_state (GsApp *app, AsAppState state)
@@ -836,6 +858,8 @@ gs_app_set_state (GsApp *app, AsAppState state)
* Gets the kind of the application.
*
* Returns: the #AsAppKind, e.g. %AS_APP_KIND_UNKNOWN
+ *
+ * Since: 3.22
**/
AsAppKind
gs_app_get_kind (GsApp *app)
@@ -858,6 +882,8 @@ gs_app_get_kind (GsApp *app)
* PACKAGE --> SYSTEM
* NORMAL --> SYSTEM
* ]|
+ *
+ * Since: 3.22
**/
void
gs_app_set_kind (GsApp *app, AsAppKind kind)
@@ -906,6 +932,8 @@ gs_app_set_kind (GsApp *app, AsAppKind kind)
* If nothing has been set the value from gs_app_get_id() will be used.
*
* Returns: The unique ID, e.g. `system/package/fedora/desktop/gimp.desktop/i386/master`, or %NULL
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_unique_id (GsApp *app)
@@ -961,6 +989,8 @@ gs_app_set_unique_id (GsApp *app, const gchar *unique_id)
* Gets the application name.
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_name (GsApp *app)
@@ -976,6 +1006,8 @@ gs_app_get_name (GsApp *app)
* @name: The short localized name, e.g. "Calculator"
*
* Sets the application name.
+ *
+ * Since: 3.22
**/
void
gs_app_set_name (GsApp *app, GsAppQuality quality, const gchar *name)
@@ -998,6 +1030,8 @@ gs_app_set_name (GsApp *app, GsAppQuality quality, const gchar *name)
* Gets the application branch.
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_branch (GsApp *app)
@@ -1012,6 +1046,8 @@ gs_app_get_branch (GsApp *app)
* @branch: The branch, e.g. "master"
*
* Sets the application branch.
+ *
+ * Since: 3.22
**/
void
gs_app_set_branch (GsApp *app, const gchar *branch)
@@ -1031,6 +1067,8 @@ gs_app_set_branch (GsApp *app, const gchar *branch)
* Gets the default source.
*
* Returns: a string, or %NULL
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_source_default (GsApp *app)
@@ -1047,6 +1085,8 @@ gs_app_get_source_default (GsApp *app)
* @source: a source name
*
* Adds a source name for the application.
+ *
+ * Since: 3.22
**/
void
gs_app_add_source (GsApp *app, const gchar *source)
@@ -1073,6 +1113,8 @@ gs_app_add_source (GsApp *app, const gchar *source)
* Gets the list of sources for the application.
*
* Returns: (element-type utf8) (transfer none): a list
+ *
+ * Since: 3.22
**/
GPtrArray *
gs_app_get_sources (GsApp *app)
@@ -1089,6 +1131,8 @@ gs_app_get_sources (GsApp *app)
* This name is used for the update page if the application is collected into
* the 'OS Updates' group.
* It is typically the package names, although this should not be relied upon.
+ *
+ * Since: 3.22
**/
void
gs_app_set_sources (GsApp *app, GPtrArray *sources)
@@ -1106,6 +1150,8 @@ gs_app_set_sources (GsApp *app, GPtrArray *sources)
* Gets the default source ID.
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_source_id_default (GsApp *app)
@@ -1123,6 +1169,8 @@ gs_app_get_source_id_default (GsApp *app)
* Gets the list of source IDs.
*
* Returns: (element-type utf8) (transfer none): a list
+ *
+ * Since: 3.22
**/
GPtrArray *
gs_app_get_source_ids (GsApp *app)
@@ -1136,6 +1184,8 @@ gs_app_get_source_ids (GsApp *app)
* @app: a #GsApp
*
* Clear the list of source IDs.
+ *
+ * Since: 3.22
**/
void
gs_app_clear_source_ids (GsApp *app)
@@ -1151,6 +1201,8 @@ gs_app_clear_source_ids (GsApp *app)
* or ["/home/hughsie/.local/share/applications/0ad.desktop"]
*
* This ID is used internally to the controlling plugin.
+ *
+ * Since: 3.22
**/
void
gs_app_set_source_ids (GsApp *app, GPtrArray *source_ids)
@@ -1167,6 +1219,8 @@ gs_app_set_source_ids (GsApp *app, GPtrArray *source_ids)
* @source_id: a source ID, e.g. "gnome-calculator;0.134;fedora"
*
* Adds a source ID to the application.
+ *
+ * Since: 3.22
**/
void
gs_app_add_source_id (GsApp *app, const gchar *source_id)
@@ -1194,6 +1248,8 @@ gs_app_add_source_id (GsApp *app, const gchar *source_id)
* this software center.
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_project_group (GsApp *app)
@@ -1208,6 +1264,8 @@ gs_app_get_project_group (GsApp *app)
* @project_group: The non-localized project group, e.g. "GNOME" or "KDE"
*
* Sets a project group for the application.
+ *
+ * Since: 3.22
**/
void
gs_app_set_project_group (GsApp *app, const gchar *project_group)
@@ -1224,6 +1282,8 @@ gs_app_set_project_group (GsApp *app, const gchar *project_group)
* Gets a pixbuf to represent the application.
*
* Returns: (transfer none): a #GdkPixbuf, or %NULL
+ *
+ * Since: 3.22
**/
GdkPixbuf *
gs_app_get_pixbuf (GsApp *app)
@@ -1239,6 +1299,8 @@ gs_app_get_pixbuf (GsApp *app)
* Gets the icons for the application.
*
* Returns: (transfer none) (element-type AsIcon): an array of icons
+ *
+ * Since: 3.22
**/
GPtrArray *
gs_app_get_icons (GsApp *app)
@@ -1254,6 +1316,8 @@ gs_app_get_icons (GsApp *app)
*
* Adds an icon to use for the application.
* If the first icon added cannot be loaded then the next one is tried.
+ *
+ * Since: 3.22
**/
void
gs_app_add_icon (GsApp *app, AsIcon *icon)
@@ -1274,6 +1338,8 @@ gs_app_add_icon (GsApp *app, AsIcon *icon)
* be a local file in ~/Downloads that we are installing.
*
* Returns: (transfer none): a #GFile, or %NULL
+ *
+ * Since: 3.22
**/
GFile *
gs_app_get_local_file (GsApp *app)
@@ -1289,6 +1355,8 @@ gs_app_get_local_file (GsApp *app)
*
* Sets the file that backs this application, for instance this might
* be a local file in ~/Downloads that we are installing.
+ *
+ * Since: 3.22
**/
void
gs_app_set_local_file (GsApp *app, GFile *local_file)
@@ -1304,6 +1372,8 @@ gs_app_set_local_file (GsApp *app, GFile *local_file)
* Gets the runtime for the application.
*
* Returns: (transfer none): a #GsApp, or %NULL for unset
+ *
+ * Since: 3.22
**/
GsApp *
gs_app_get_runtime (GsApp *app)
@@ -1318,6 +1388,8 @@ gs_app_get_runtime (GsApp *app)
* @runtime: a #GsApp
*
* Sets the runtime that the application requires.
+ *
+ * Since: 3.22
**/
void
gs_app_set_runtime (GsApp *app, GsApp *runtime)
@@ -1332,6 +1404,8 @@ gs_app_set_runtime (GsApp *app, GsApp *runtime)
* @pixbuf: a #GdkPixbuf, or %NULL
*
* Sets a pixbuf used to represent the application.
+ *
+ * Since: 3.22
**/
void
gs_app_set_pixbuf (GsApp *app, GdkPixbuf *pixbuf)
@@ -1448,6 +1522,8 @@ gs_app_ui_versions_populate (GsApp *app)
* Gets the exact version for the application.
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_version (GsApp *app)
@@ -1463,6 +1539,8 @@ gs_app_get_version (GsApp *app)
* Gets a version string that can be displayed in a UI.
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_version_ui (GsApp *app)
@@ -1485,6 +1563,8 @@ gs_app_get_version_ui (GsApp *app)
*
* This saves the version after stripping out any non-friendly parts, such as
* distro tags, git revisions and that kind of thing.
+ *
+ * Since: 3.22
**/
void
gs_app_set_version (GsApp *app, const gchar *version)
@@ -1503,6 +1583,8 @@ gs_app_set_version (GsApp *app, const gchar *version)
* Gets the single-line description of the application.
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_summary (GsApp *app)
@@ -1518,6 +1600,8 @@ gs_app_get_summary (GsApp *app)
* @summary: a string, e.g. "A graphical calculator for GNOME"
*
* The medium length one-line localized name.
+ *
+ * Since: 3.22
**/
void
gs_app_set_summary (GsApp *app, GsAppQuality quality, const gchar *summary)
@@ -1540,6 +1624,8 @@ gs_app_set_summary (GsApp *app, GsAppQuality quality, const gchar *summary)
* Gets the long multi-line description of the application.
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_description (GsApp *app)
@@ -1555,6 +1641,8 @@ gs_app_get_description (GsApp *app)
* @description: a string, e.g. "GNOME Calculator is a graphical calculator for GNOME..."
*
* Sets the long multi-line description of the application.
+ *
+ * Since: 3.22
**/
void
gs_app_set_description (GsApp *app, GsAppQuality quality, const gchar *description)
@@ -1578,6 +1666,8 @@ gs_app_set_description (GsApp *app, GsAppQuality quality, const gchar *descripti
* Gets a web address of a specific type.
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_url (GsApp *app, AsUrlKind kind)
@@ -1593,6 +1683,8 @@ gs_app_get_url (GsApp *app, AsUrlKind kind)
* @url: a web URL, e.g. "http://www.hughsie.com/";
*
* Sets a web address of a specific type.
+ *
+ * Since: 3.22
**/
void
gs_app_set_url (GsApp *app, AsUrlKind kind, const gchar *url)
@@ -1610,6 +1702,8 @@ gs_app_set_url (GsApp *app, AsUrlKind kind, const gchar *url)
* Gets the project license of the application.
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_license (GsApp *app)
@@ -1625,6 +1719,8 @@ gs_app_get_license (GsApp *app)
* Returns if the application is free software.
*
* Returns: %TRUE if the application is free software
+ *
+ * Since: 3.22
**/
gboolean
gs_app_get_license_is_free (GsApp *app)
@@ -1657,6 +1753,8 @@ gs_app_get_license_token_is_nonfree (const gchar *token)
* @license: a SPDX license string, e.g. "GPL-3.0 AND LGPL-2.0+"
*
* Sets the project licenses used in the application.
+ *
+ * Since: 3.22
**/
void
gs_app_set_license (GsApp *app, GsAppQuality quality, const gchar *license)
@@ -1699,6 +1797,8 @@ gs_app_set_license (GsApp *app, GsAppQuality quality, const gchar *license)
* Gets the one-line summary to use when this application is missing.
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_summary_missing (GsApp *app)
@@ -1713,6 +1813,8 @@ gs_app_get_summary_missing (GsApp *app)
* @summary_missing: a string, or %NULL
*
* Sets the one-line summary to use when this application is missing.
+ *
+ * Since: 3.22
**/
void
gs_app_set_summary_missing (GsApp *app, const gchar *summary_missing)
@@ -1731,6 +1833,8 @@ gs_app_set_summary_missing (GsApp *app, const gchar *summary_missing)
* modified or freed.
*
* Returns: a %NULL-terminated array of strings
+ *
+ * Since: 3.22
**/
gchar **
gs_app_get_menu_path (GsApp *app)
@@ -1746,6 +1850,8 @@ gs_app_get_menu_path (GsApp *app)
*
* Sets the new menu path. The menu path is an array of path elements.
* This function creates a deep copy of the path.
+ *
+ * Since: 3.22
**/
void
gs_app_set_menu_path (GsApp *app, gchar **menu_path)
@@ -1762,6 +1868,8 @@ gs_app_set_menu_path (GsApp *app, gchar **menu_path)
* Gets the origin for the application, e.g. "fedora".
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_origin (GsApp *app)
@@ -1776,6 +1884,8 @@ gs_app_get_origin (GsApp *app)
* @origin: a string, or %NULL
*
* The origin is the original source of the application e.g. "fedora-updates"
+ *
+ * Since: 3.22
**/
void
gs_app_set_origin (GsApp *app, const gchar *origin)
@@ -1807,6 +1917,8 @@ gs_app_set_origin (GsApp *app, const gchar *origin)
* Gets the UI-visible origin used to install the application, e.g. "Fedora".
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_origin_ui (GsApp *app)
@@ -1822,6 +1934,8 @@ gs_app_get_origin_ui (GsApp *app)
*
* The origin is the original source of the application to show in the UI,
* e.g. "Fedora"
+ *
+ * Since: 3.22
**/
void
gs_app_set_origin_ui (GsApp *app, const gchar *origin_ui)
@@ -1841,6 +1955,8 @@ gs_app_set_origin_ui (GsApp *app, const gchar *origin_ui)
* "fedoraproject.org" or "sdk.gnome.org".
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_origin_hostname (GsApp *app)
@@ -1860,6 +1976,8 @@ gs_app_get_origin_hostname (GsApp *app)
* You can also use a full URL as @origin_hostname and this will be parsed and
* the hostname extracted. This process will also remove any unnecessary DNS
* prefixes like "download" or "mirrors".
+ *
+ * Since: 3.22
**/
void
gs_app_set_origin_hostname (GsApp *app, const gchar *origin_hostname)
@@ -1895,6 +2013,8 @@ gs_app_set_origin_hostname (GsApp *app, const gchar *origin_hostname)
* @screenshot: a #AsScreenshot
*
* Adds a screenshot to the applicaton.
+ *
+ * Since: 3.22
**/
void
gs_app_add_screenshot (GsApp *app, AsScreenshot *screenshot)
@@ -1911,6 +2031,8 @@ gs_app_add_screenshot (GsApp *app, AsScreenshot *screenshot)
* Gets the list of screenshots.
*
* Returns: (element-type AsScreenshot) (transfer none): a list
+ *
+ * Since: 3.22
**/
GPtrArray *
gs_app_get_screenshots (GsApp *app)
@@ -1926,6 +2048,8 @@ gs_app_get_screenshots (GsApp *app)
* Gets the newest update version.
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_update_version (GsApp *app)
@@ -1941,6 +2065,8 @@ gs_app_get_update_version (GsApp *app)
* Gets the update version for the UI.
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_update_version_ui (GsApp *app)
@@ -1970,6 +2096,8 @@ gs_app_set_update_version_internal (GsApp *app, const gchar *update_version)
* @update_version: a string, e.g. "0.1.2.3"
*
* Sets the new version number of the update.
+ *
+ * Since: 3.22
**/
void
gs_app_set_update_version (GsApp *app, const gchar *update_version)
@@ -1986,6 +2114,8 @@ gs_app_set_update_version (GsApp *app, const gchar *update_version)
* Gets the multi-line description for the update.
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_update_details (GsApp *app)
@@ -2000,6 +2130,8 @@ gs_app_get_update_details (GsApp *app)
* @update_details: a string
*
* Sets the multi-line description for the update.
+ *
+ * Since: 3.22
**/
void
gs_app_set_update_details (GsApp *app, const gchar *update_details)
@@ -2016,6 +2148,8 @@ gs_app_set_update_details (GsApp *app, const gchar *update_details)
* Gets the update urgency.
*
* Returns: a #AsUrgencyKind, or %AS_URGENCY_KIND_UNKNOWN for unset
+ *
+ * Since: 3.22
**/
AsUrgencyKind
gs_app_get_update_urgency (GsApp *app)
@@ -2030,6 +2164,8 @@ gs_app_get_update_urgency (GsApp *app)
* @update_urgency: a #AsUrgencyKind
*
* Sets the update urgency.
+ *
+ * Since: 3.22
**/
void
gs_app_set_update_urgency (GsApp *app, AsUrgencyKind update_urgency)
@@ -2050,6 +2186,8 @@ gs_app_set_update_urgency (GsApp *app, AsUrgencyKind update_urgency)
* gs_plugin_get_name().
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_management_plugin (GsApp *app)
@@ -2069,6 +2207,8 @@ gs_app_get_management_plugin (GsApp *app)
*
* It is an error to attempt to change the management plugin once
* it has been previously set.
+ *
+ * Since: 3.22
**/
void
gs_app_set_management_plugin (GsApp *app, const gchar *management_plugin)
@@ -2100,6 +2240,8 @@ gs_app_set_management_plugin (GsApp *app, const gchar *management_plugin)
* Gets the percentage rating of the application, where 100 is 5 stars.
*
* Returns: a percentage, or -1 for unset
+ *
+ * Since: 3.22
**/
gint
gs_app_get_rating (GsApp *app)
@@ -2114,6 +2256,8 @@ gs_app_get_rating (GsApp *app)
* @rating: a percentage, or -1 for invalid
*
* Gets the percentage rating of the application.
+ *
+ * Since: 3.22
**/
void
gs_app_set_rating (GsApp *app, gint rating)
@@ -2130,6 +2274,8 @@ gs_app_set_rating (GsApp *app, gint rating)
* Gets the review ratings.
*
* Returns: (element-type gint) (transfer none): a list
+ *
+ * Since: 3.22
**/
GArray *
gs_app_get_review_ratings (GsApp *app)
@@ -2144,6 +2290,8 @@ gs_app_get_review_ratings (GsApp *app)
* @review_ratings: (element-type gint): a list
*
* Sets the review ratings.
+ *
+ * Since: 3.22
**/
void
gs_app_set_review_ratings (GsApp *app, GArray *review_ratings)
@@ -2161,6 +2309,8 @@ gs_app_set_review_ratings (GsApp *app, GArray *review_ratings)
* Gets all the user-submitted reviews for the application.
*
* Returns: (element-type AsReview) (transfer none): the list of reviews
+ *
+ * Since: 3.22
**/
GPtrArray *
gs_app_get_reviews (GsApp *app)
@@ -2175,6 +2325,8 @@ gs_app_get_reviews (GsApp *app)
* @review: a #AsReview
*
* Adds a user-submitted review to the application.
+ *
+ * Since: 3.22
**/
void
gs_app_add_review (GsApp *app, AsReview *review)
@@ -2190,6 +2342,8 @@ gs_app_add_review (GsApp *app, AsReview *review)
* @review: a #AsReview
*
* Removes a user-submitted review to the application.
+ *
+ * Since: 3.22
**/
void
gs_app_remove_review (GsApp *app, AsReview *review)
@@ -2208,6 +2362,8 @@ gs_app_remove_review (GsApp *app, AsReview *review)
* If there is a runtime not yet installed then this is also added.
*
* Returns: number of bytes, 0 for unknown, or %GS_APP_SIZE_UNKNOWABLE for invalid
+ *
+ * Since: 3.22
**/
guint64
gs_app_get_size_download (GsApp *app)
@@ -2235,6 +2391,8 @@ gs_app_get_size_download (GsApp *app)
*
* Sets the download size of the application, not including any
* required runtime.
+ *
+ * Since: 3.22
**/
void
gs_app_set_size_download (GsApp *app, guint64 size_download)
@@ -2253,6 +2411,8 @@ gs_app_set_size_download (GsApp *app, guint64 size_download)
* If there is a runtime not yet installed then this is also added.
*
* Returns: size in bytes, 0 for unknown, or %GS_APP_SIZE_UNKNOWABLE for invalid.
+ *
+ * Since: 3.22
**/
guint64
gs_app_get_size_installed (GsApp *app)
@@ -2279,6 +2439,8 @@ gs_app_get_size_installed (GsApp *app)
* @size_installed: size in bytes, or %GS_APP_SIZE_UNKNOWABLE for invalid
*
* Sets the installed size of the application.
+ *
+ * Since: 3.22
**/
void
gs_app_set_size_installed (GsApp *app, guint64 size_installed)
@@ -2297,6 +2459,8 @@ gs_app_set_size_installed (GsApp *app, guint64 size_installed)
* for example `fwupd::device-id`.
*
* Returns: a string, or %NULL for unset
+ *
+ * Since: 3.22
**/
const gchar *
gs_app_get_metadata_item (GsApp *app, const gchar *key)
@@ -2315,6 +2479,8 @@ gs_app_get_metadata_item (GsApp *app, const gchar *key)
* Sets some metadata for the application.
* Is is expected that plugins namespace any plugin-specific metadata,
* for example `fwupd::device-id`.
+ *
+ * Since: 3.22
**/
void
gs_app_set_metadata (GsApp *app, const gchar *key, const gchar *value)
@@ -2353,6 +2519,8 @@ gs_app_set_metadata (GsApp *app, const gchar *key, const gchar *value)
* Gets the list of addons for the application.
*
* Returns: (element-type GsApp) (transfer none): a list of addons
+ *
+ * Since: 3.22
**/
GPtrArray *
gs_app_get_addons (GsApp *app)
@@ -2367,6 +2535,8 @@ gs_app_get_addons (GsApp *app)
* @addon: a #GsApp
*
* Adds an addon to the list of application addons.
+ *
+ * Since: 3.22
**/
void
gs_app_add_addon (GsApp *app, GsApp *addon)
@@ -2393,6 +2563,8 @@ gs_app_add_addon (GsApp *app, GsApp *addon)
* Gets any related applications.
*
* Returns: (element-type GsApp) (transfer none): a list of applications
+ *
+ * Since: 3.22
**/
GPtrArray *
gs_app_get_related (GsApp *app)
@@ -2407,6 +2579,8 @@ gs_app_get_related (GsApp *app)
* @app2: a #GsApp
*
* Adds a related application.
+ *
+ * Since: 3.22
**/
void
gs_app_add_related (GsApp *app, GsApp *app2)
@@ -2443,6 +2617,8 @@ gs_app_add_related (GsApp *app, GsApp *app2)
* Gets the history of this application.
*
* Returns: (element-type GsApp) (transfer none): a list
+ *
+ * Since: 3.22
**/
GPtrArray *
gs_app_get_history (GsApp *app)
@@ -2457,6 +2633,8 @@ gs_app_get_history (GsApp *app)
* @app2: a #GsApp
*
* Adds a history item for this package.
+ *
+ * Since: 3.22
**/
void
gs_app_add_history (GsApp *app, GsApp *app2)
@@ -2472,6 +2650,8 @@ gs_app_add_history (GsApp *app, GsApp *app2)
* Gets the date that an application was installed.
*
* Returns: A UNIX epoch, or 0 for unset
+ *
+ * Since: 3.22
**/
guint64
gs_app_get_install_date (GsApp *app)
@@ -2486,6 +2666,8 @@ gs_app_get_install_date (GsApp *app)
* @install_date: an epoch, or %GS_APP_INSTALL_DATE_UNKNOWN
*
* Sets the date that an application was installed.
+ *
+ * Since: 3.22
**/
void
gs_app_set_install_date (GsApp *app, guint64 install_date)
@@ -2501,6 +2683,8 @@ gs_app_set_install_date (GsApp *app, guint64 install_date)
* Gets whether the app is installed or not.
*
* Returns: %TRUE if the app is installed, %FALSE otherwise.
+ *
+ * Since: 3.22
**/
gboolean
gs_app_is_installed (GsApp *app)
@@ -2523,6 +2707,8 @@ gs_app_is_installed (GsApp *app)
* Gets the list of categories for an application.
*
* Returns: (element-type utf8) (transfer none): a list
+ *
+ * Since: 3.22
**/
GPtrArray *
gs_app_get_categories (GsApp *app)
@@ -2539,6 +2725,8 @@ gs_app_get_categories (GsApp *app)
* Checks if the application is in a specific category.
*
* Returns: %TRUE for success
+ *
+ * Since: 3.22
**/
gboolean
gs_app_has_category (GsApp *app, const gchar *category)
@@ -2563,6 +2751,8 @@ gs_app_has_category (GsApp *app, const gchar *category)
* @categories: a set of categories
*
* Set the list of categories for an application.
+ *
+ * Since: 3.22
**/
void
gs_app_set_categories (GsApp *app, GPtrArray *categories)
@@ -2580,6 +2770,8 @@ gs_app_set_categories (GsApp *app, GPtrArray *categories)
* @category: a category ID, e.g. "AudioVideo"
*
* Adds a category ID to an application.
+ *
+ * Since: 3.22
**/
void
gs_app_add_category (GsApp *app, const gchar *category)
@@ -2598,6 +2790,8 @@ gs_app_add_category (GsApp *app, const gchar *category)
* Gets the key colors used in the application icon.
*
* Returns: (element-type GdkRGBA) (transfer none): a list
+ *
+ * Since: 3.22
**/
GPtrArray *
gs_app_get_key_colors (GsApp *app)
@@ -2612,6 +2806,8 @@ gs_app_get_key_colors (GsApp *app)
* @key_colors: (element-type GdkRGBA): a set of key colors
*
* Sets the key colors used in the application icon.
+ *
+ * Since: 3.22
**/
void
gs_app_set_key_colors (GsApp *app, GPtrArray *key_colors)
@@ -2629,6 +2825,8 @@ gs_app_set_key_colors (GsApp *app, GPtrArray *key_colors)
* @key_color: a #GdkRGBA
*
* Adds a key colors used in the application icon.
+ *
+ * Since: 3.22
**/
void
gs_app_add_key_color (GsApp *app, GdkRGBA *key_color)
@@ -2645,6 +2843,8 @@ gs_app_add_key_color (GsApp *app, GdkRGBA *key_color)
* Gets the list of application keywords in the users locale.
*
* Returns: (element-type utf8) (transfer none): a list
+ *
+ * Since: 3.22
**/
GPtrArray *
gs_app_get_keywords (GsApp *app)
@@ -2659,6 +2859,8 @@ gs_app_get_keywords (GsApp *app)
* @keywords: (element-type utf8): a set of keywords
*
* Sets the list of application keywords in the users locale.
+ *
+ * Since: 3.22
**/
void
gs_app_set_keywords (GsApp *app, GPtrArray *keywords)
@@ -2676,6 +2878,8 @@ gs_app_set_keywords (GsApp *app, GPtrArray *keywords)
* @kudo: a #GsAppKudo, e.g. %GS_APP_KUDO_MY_LANGUAGE
*
* Adds a kudo to the application.
+ *
+ * Since: 3.22
**/
void
gs_app_add_kudo (GsApp *app, GsAppKudo kudo)
@@ -2693,6 +2897,8 @@ gs_app_add_kudo (GsApp *app, GsAppKudo kudo)
* Gets all the kudos the application has been awarded.
*
* Returns: the kudos, as a bitfield
+ *
+ * Since: 3.22
**/
guint64
gs_app_get_kudos (GsApp *app)
@@ -2708,6 +2914,8 @@ gs_app_get_kudos (GsApp *app)
* Gets the kudos, as a percentage value.
*
* Returns: a percentage, with 0 for no kudos and a maximum of 100.
+ *
+ * Since: 3.22
**/
guint
gs_app_get_kudos_percentage (GsApp *app)
@@ -2767,6 +2975,8 @@ gs_app_get_kudos_percentage (GsApp *app)
* same time. This is never set when applications do not have addons.
*
* Returns: %TRUE for success
+ *
+ * Since: 3.22
**/
gboolean
gs_app_get_to_be_installed (GsApp *app)
@@ -2782,6 +2992,8 @@ gs_app_get_to_be_installed (GsApp *app)
* @to_be_installed: if the app is due to be installed
*
* Sets if the application is queued for installation.
+ *
+ * Since: 3.22
**/
void
gs_app_set_to_be_installed (GsApp *app, gboolean to_be_installed)
@@ -2799,6 +3011,8 @@ gs_app_set_to_be_installed (GsApp *app, gboolean to_be_installed)
* Finds out if an application has a specific quirk.
*
* Returns: %TRUE for success
+ *
+ * Since: 3.22
**/
gboolean
gs_app_has_quirk (GsApp *app, AsAppQuirk quirk)
@@ -2814,6 +3028,8 @@ gs_app_has_quirk (GsApp *app, AsAppQuirk quirk)
* @quirk: a #AsAppQuirk, e.g. %AS_APP_QUIRK_COMPULSORY
*
* Adds a quirk to an application.
+ *
+ * Since: 3.22
**/
void
gs_app_add_quirk (GsApp *app, AsAppQuirk quirk)
@@ -2830,6 +3046,8 @@ gs_app_add_quirk (GsApp *app, AsAppQuirk quirk)
* @quirk: a #AsAppQuirk, e.g. %AS_APP_QUIRK_COMPULSORY
*
* Removes a quirk from an application.
+ *
+ * Since: 3.22
**/
void
gs_app_remove_quirk (GsApp *app, AsAppQuirk quirk)
@@ -2847,6 +3065,8 @@ gs_app_remove_quirk (GsApp *app, AsAppQuirk quirk)
*
* Set a match quality value, where higher values correspond to a
* "better" search match, and should be shown above lower results.
+ *
+ * Since: 3.22
**/
void
gs_app_set_match_value (GsApp *app, guint match_value)
@@ -2867,6 +3087,8 @@ gs_app_set_match_value (GsApp *app, guint match_value)
* a cache.
*
* Returns: a value, where higher is better
+ *
+ * Since: 3.22
**/
guint
gs_app_get_match_value (GsApp *app)
@@ -2881,6 +3103,8 @@ gs_app_get_match_value (GsApp *app)
* @priority: a value
*
* Set a priority value.
+ *
+ * Since: 3.22
**/
void
gs_app_set_priority (GsApp *app, guint priority)
@@ -2897,6 +3121,8 @@ gs_app_set_priority (GsApp *app, guint priority)
* multiple #GsApp's match a specific rule.
*
* Returns: a value, where higher is better
+ *
+ * Since: 3.22
**/
guint
gs_app_get_priority (GsApp *app)
@@ -2912,6 +3138,8 @@ gs_app_get_priority (GsApp *app)
* Get the last error.
*
* Returns: a #GError, or %NULL
+ *
+ * Since: 3.22
**/
GError *
gs_app_get_last_error (GsApp *app)
@@ -2925,6 +3153,8 @@ gs_app_get_last_error (GsApp *app)
* @error: a #GError
*
* Sets the last error.
+ *
+ * Since: 3.22
**/
void
gs_app_set_last_error (GsApp *app, GError *error)
@@ -3239,6 +3469,8 @@ gs_app_init (GsApp *app)
* like the application icon and long description.
*
* Returns: a new #GsApp
+ *
+ * Since: 3.22
**/
GsApp *
gs_app_new (const gchar *id)
diff --git a/src/gs-category.c b/src/gs-category.c
index 5018b56..2eac2c3 100644
--- a/src/gs-category.c
+++ b/src/gs-category.c
@@ -58,6 +58,8 @@ G_DEFINE_TYPE (GsCategory, gs_category, G_TYPE_OBJECT)
* Returns a string representation of the category
*
* Returns: a string
+ *
+ * Since: 3.22
**/
gchar *
gs_category_to_string (GsCategory *category)
@@ -110,6 +112,8 @@ gs_category_to_string (GsCategory *category)
* filtered or core applications are not shown.
*
* Returns: the number of apps in the category
+ *
+ * Since: 3.22
**/
guint
gs_category_get_size (GsCategory *category)
@@ -125,6 +129,8 @@ gs_category_get_size (GsCategory *category)
*
* Sets the number of applications in the category.
* Most plugins do not need to call this function.
+ *
+ * Since: 3.22
**/
void
gs_category_set_size (GsCategory *category, guint size)
@@ -138,6 +144,8 @@ gs_category_set_size (GsCategory *category, guint size)
* @category: a #GsCategory
*
* Adds one to the size count if an application is available
+ *
+ * Since: 3.22
**/
void
gs_category_increment_size (GsCategory *category)
@@ -153,6 +161,8 @@ gs_category_increment_size (GsCategory *category)
* Gets the category ID.
*
* Returns: the string, e.g. "other"
+ *
+ * Since: 3.22
**/
const gchar *
gs_category_get_id (GsCategory *category)
@@ -168,6 +178,8 @@ gs_category_get_id (GsCategory *category)
* Gets the category name.
*
* Returns: the string, or %NULL
+ *
+ * Since: 3.22
**/
const gchar *
gs_category_get_name (GsCategory *category)
@@ -199,6 +211,8 @@ gs_category_get_name (GsCategory *category)
* @name: a category name, or %NULL
*
* Sets the category name.
+ *
+ * Since: 3.22
**/
void
gs_category_set_name (GsCategory *category, const gchar *name)
@@ -215,6 +229,8 @@ gs_category_set_name (GsCategory *category, const gchar *name)
* Gets the category icon.
*
* Returns: the string, or %NULL
+ *
+ * Since: 3.22
**/
const gchar *
gs_category_get_icon (GsCategory *category)
@@ -238,6 +254,8 @@ gs_category_get_icon (GsCategory *category)
* @icon: a category icon, or %NULL
*
* Sets the category icon.
+ *
+ * Since: 3.22
**/
void
gs_category_set_icon (GsCategory *category, const gchar *icon)
@@ -256,6 +274,8 @@ gs_category_set_icon (GsCategory *category, const gchar *icon)
* different way, for example with color or in a different section.
*
* Returns: the string, or %NULL
+ *
+ * Since: 3.22
**/
gint
gs_category_get_score (GsCategory *category)
@@ -271,6 +291,8 @@ gs_category_get_score (GsCategory *category)
*
* Sets the category score, where larger numbers get sorted before lower
* numbers.
+ *
+ * Since: 3.22
**/
void
gs_category_set_score (GsCategory *category, gint score)
@@ -286,6 +308,8 @@ gs_category_set_score (GsCategory *category, gint score)
* Gets the list of key colors for the category.
*
* Returns: (element-type GdkRGBA) (transfer none): An array
+ *
+ * Since: 3.22
**/
GPtrArray *
gs_category_get_key_colors (GsCategory *category)
@@ -300,6 +324,8 @@ gs_category_get_key_colors (GsCategory *category)
* @key_color: a #GdkRGBA
*
* Adds a key color to the category.
+ *
+ * Since: 3.22
**/
void
gs_category_add_key_color (GsCategory *category, const GdkRGBA *key_color)
@@ -316,6 +342,8 @@ gs_category_add_key_color (GsCategory *category, const GdkRGBA *key_color)
* Gets the list of AppStream groups for the category.
*
* Returns: (element-type utf8) (transfer none): An array
+ *
+ * Since: 3.22
**/
GPtrArray *
gs_category_get_desktop_groups (GsCategory *category)
@@ -332,6 +360,8 @@ gs_category_get_desktop_groups (GsCategory *category)
* Finds out if the category has the specific AppStream desktop group.
*
* Returns: %TRUE if found, %FALSE otherwise
+ *
+ * Since: 3.22
**/
gboolean
gs_category_has_desktop_group (GsCategory *category, const gchar *desktop_group)
@@ -356,6 +386,8 @@ gs_category_has_desktop_group (GsCategory *category, const gchar *desktop_group)
*
* Adds a desktop group to the category.
* A desktop group is a set of category strings that all must exist.
+ *
+ * Since: 3.22
**/
void
gs_category_add_desktop_group (GsCategory *category, const gchar *desktop_group)
@@ -377,6 +409,8 @@ gs_category_add_desktop_group (GsCategory *category, const gchar *desktop_group)
* Find a child category with a specific ID.
*
* Returns: (transfer none): the #GsCategory, or %NULL
+ *
+ * Since: 3.22
**/
GsCategory *
gs_category_find_child (GsCategory *category, const gchar *id)
@@ -400,6 +434,8 @@ gs_category_find_child (GsCategory *category, const gchar *id)
* Gets the parent category.
*
* Returns: the #GsCategory or %NULL
+ *
+ * Since: 3.22
**/
GsCategory *
gs_category_get_parent (GsCategory *category)
@@ -415,6 +451,8 @@ gs_category_get_parent (GsCategory *category)
* Gets the list if children for a category.
*
* Return value: (element-type GsApp) (transfer none): A list of children
+ *
+ * Since: 3.22
**/
GPtrArray *
gs_category_get_children (GsCategory *category)
@@ -429,6 +467,8 @@ gs_category_get_children (GsCategory *category)
* @subcategory: a #GsCategory
*
* Adds a child category to a parent category.
+ *
+ * Since: 3.22
**/
void
gs_category_add_child (GsCategory *category, GsCategory *subcategory)
@@ -475,6 +515,8 @@ gs_category_sort_children_cb (gconstpointer a, gconstpointer b)
* @category: a #GsCategory
*
* Sorts the list of children.
+ *
+ * Since: 3.22
**/
void
gs_category_sort_children (GsCategory *category)
@@ -524,6 +566,8 @@ gs_category_init (GsCategory *category)
* Creates a new category object.
*
* Returns: the new #GsCategory
+ *
+ * Since: 3.22
**/
GsCategory *
gs_category_new (const gchar *id)
diff --git a/src/gs-os-release.c b/src/gs-os-release.c
index c43ae17..8ed662f 100644
--- a/src/gs-os-release.c
+++ b/src/gs-os-release.c
@@ -132,6 +132,8 @@ gs_os_release_initable_init (GInitable *initable,
* Gets the name from the os-release parser.
*
* Returns: a string, or %NULL
+ *
+ * Since: 3.22
**/
const gchar *
gs_os_release_get_name (GsOsRelease *os_release)
@@ -147,6 +149,8 @@ gs_os_release_get_name (GsOsRelease *os_release)
* Gets the version from the os-release parser.
*
* Returns: a string, or %NULL
+ *
+ * Since: 3.22
**/
const gchar *
gs_os_release_get_version (GsOsRelease *os_release)
@@ -162,6 +166,8 @@ gs_os_release_get_version (GsOsRelease *os_release)
* Gets the ID from the os-release parser.
*
* Returns: a string, or %NULL
+ *
+ * Since: 3.22
**/
const gchar *
gs_os_release_get_id (GsOsRelease *os_release)
@@ -177,6 +183,8 @@ gs_os_release_get_id (GsOsRelease *os_release)
* Gets the version ID from the os-release parser.
*
* Returns: a string, or %NULL
+ *
+ * Since: 3.22
**/
const gchar *
gs_os_release_get_version_id (GsOsRelease *os_release)
@@ -192,6 +200,8 @@ gs_os_release_get_version_id (GsOsRelease *os_release)
* Gets the pretty name from the os-release parser.
*
* Returns: a string, or %NULL
+ *
+ * Since: 3.22
**/
const gchar *
gs_os_release_get_pretty_name (GsOsRelease *os_release)
@@ -207,6 +217,8 @@ gs_os_release_get_pretty_name (GsOsRelease *os_release)
* Gets the distro codename from the os-release parser.
*
* Returns: a string, or %NULL
+ *
+ * Since: 3.22
**/
const gchar *
gs_os_release_get_distro_codename (GsOsRelease *os_release)
@@ -253,6 +265,8 @@ gs_os_release_init (GsOsRelease *os_release)
* Creates a new os_release.
*
* Returns: (transfer full): A newly allocated #GsOsRelease, or %NULL for error
+ *
+ * Since: 3.22
**/
GsOsRelease *
gs_os_release_new (GError **error)
diff --git a/src/gs-plugin.c b/src/gs-plugin.c
index d6f9b52..4729c33 100644
--- a/src/gs-plugin.c
+++ b/src/gs-plugin.c
@@ -101,6 +101,8 @@ typedef const gchar **(*GsPluginGetDepsFunc) (GsPlugin *plugin);
* Converts the #GsPluginStatus enum to a string.
*
* Returns: the string representation, or "unknown"
+ *
+ * Since: 3.22
**/
const gchar *
gs_plugin_status_to_string (GsPluginStatus status)
@@ -129,6 +131,8 @@ gs_plugin_status_to_string (GsPluginStatus status)
* Creates a new plugin from an external module.
*
* Returns: the #GsPlugin or %NULL
+ *
+ * Since: 3.22
**/
GsPlugin *
gs_plugin_create (const gchar *filename, GError **error)
@@ -202,6 +206,8 @@ gs_plugin_finalize (GObject *object)
* been called.
*
* Returns: the #GsPluginData, or %NULL
+ *
+ * Since: 3.22
**/
GsPluginData *
gs_plugin_get_data (GsPlugin *plugin)
@@ -222,6 +228,8 @@ gs_plugin_get_data (GsPlugin *plugin)
* not be manually freed.
*
* Returns: the #GsPluginData, cleared to NUL butes
+ *
+ * Since: 3.22
**/
GsPluginData *
gs_plugin_alloc_data (GsPlugin *plugin, gsize sz)
@@ -238,6 +246,8 @@ gs_plugin_alloc_data (GsPlugin *plugin, gsize sz)
* @exclusive: if the plugin action should be performed exclusively
*
* Starts a plugin action.
+ *
+ * Since: 3.22
**/
void
gs_plugin_action_start (GsPlugin *plugin, gboolean exclusive)
@@ -274,6 +284,8 @@ gs_plugin_action_delay_cb (gpointer user_data)
* @plugin: a #GsPlugin
*
* Stops an plugin action.
+ *
+ * Since: 3.22
**/
void
gs_plugin_action_stop (GsPlugin *plugin)
@@ -308,6 +320,8 @@ gs_plugin_action_stop (GsPlugin *plugin)
* Gets the external module that backs the plugin.
*
* Returns: the #GModule, or %NULL
+ *
+ * Since: 3.22
**/
GModule *
gs_plugin_get_module (GsPlugin *plugin)
@@ -323,6 +337,8 @@ gs_plugin_get_module (GsPlugin *plugin)
* Gets if the plugin is enabled.
*
* Returns: %TRUE if enabled
+ *
+ * Since: 3.22
**/
gboolean
gs_plugin_get_enabled (GsPlugin *plugin)
@@ -338,6 +354,8 @@ gs_plugin_get_enabled (GsPlugin *plugin)
*
* Enables or disables a plugin.
* This is normally only called from gs_plugin_initialize().
+ *
+ * Since: 3.22
**/
void
gs_plugin_set_enabled (GsPlugin *plugin, gboolean enabled)
@@ -353,6 +371,8 @@ gs_plugin_set_enabled (GsPlugin *plugin, gboolean enabled)
* Gets the plugin name.
*
* Returns: a string, e.g. "fwupd"
+ *
+ * Since: 3.22
**/
const gchar *
gs_plugin_get_name (GsPlugin *plugin)
@@ -368,6 +388,8 @@ gs_plugin_get_name (GsPlugin *plugin)
* Gets the window scale factor.
*
* Returns: the factor, usually 1 for standard screens or 2 for HiDPI
+ *
+ * Since: 3.22
**/
guint
gs_plugin_get_scale (GsPlugin *plugin)
@@ -382,6 +404,8 @@ gs_plugin_get_scale (GsPlugin *plugin)
* @scale: the window scale factor, usually 1 for standard screens or 2 for HiDPI
*
* Sets the window scale factor.
+ *
+ * Since: 3.22
**/
void
gs_plugin_set_scale (GsPlugin *plugin, guint scale)
@@ -398,6 +422,8 @@ gs_plugin_set_scale (GsPlugin *plugin, guint scale)
* numbers.
*
* Returns: the integer value
+ *
+ * Since: 3.22
**/
guint
gs_plugin_get_order (GsPlugin *plugin)
@@ -413,6 +439,8 @@ gs_plugin_get_order (GsPlugin *plugin)
*
* Sets the plugin order, where higher numbers are run after lower
* numbers.
+ *
+ * Since: 3.22
**/
void
gs_plugin_set_order (GsPlugin *plugin, guint order)
@@ -429,6 +457,8 @@ gs_plugin_set_order (GsPlugin *plugin, guint order)
* multiple #GsApp's match a specific rule.
*
* Returns: the integer value
+ *
+ * Since: 3.22
**/
guint
gs_plugin_get_priority (GsPlugin *plugin)
@@ -444,6 +474,8 @@ gs_plugin_get_priority (GsPlugin *plugin)
*
* Sets the plugin priority, where higher values will be chosen where
* multiple #GsApp's match a specific rule.
+ *
+ * Since: 3.22
**/
void
gs_plugin_set_priority (GsPlugin *plugin, guint priority)
@@ -459,6 +491,8 @@ gs_plugin_set_priority (GsPlugin *plugin, guint priority)
* Gets the user locale.
*
* Returns: the locale string, e.g. "en_GB"
+ *
+ * Since: 3.22
**/
const gchar *
gs_plugin_get_locale (GsPlugin *plugin)
@@ -474,6 +508,8 @@ gs_plugin_get_locale (GsPlugin *plugin)
* Gets the user language from the locale.
*
* Returns: the language string, e.g. "fr"
+ *
+ * Since: 3.22
**/
const gchar *
gs_plugin_get_language (GsPlugin *plugin)
@@ -488,6 +524,8 @@ gs_plugin_get_language (GsPlugin *plugin)
* @locale: a locale string, e.g. "en_GB"
*
* Sets the plugin locale.
+ *
+ * Since: 3.22
**/
void
gs_plugin_set_locale (GsPlugin *plugin, const gchar *locale)
@@ -503,6 +541,8 @@ gs_plugin_set_locale (GsPlugin *plugin, const gchar *locale)
* @language: a language string, e.g. "fr"
*
* Sets the plugin language.
+ *
+ * Since: 3.22
**/
void
gs_plugin_set_language (GsPlugin *plugin, const gchar *language)
@@ -518,6 +558,8 @@ gs_plugin_set_language (GsPlugin *plugin, const gchar *language)
* @auth_array: (element-type GsAuth): an array
*
* Sets the authentication objects that can be added by the plugin.
+ *
+ * Since: 3.22
**/
void
gs_plugin_set_auth_array (GsPlugin *plugin, GPtrArray *auth_array)
@@ -532,6 +574,8 @@ gs_plugin_set_auth_array (GsPlugin *plugin, GPtrArray *auth_array)
* @auth: a #GsAuth
*
* Adds an authentication object that can be used for all the plugins.
+ *
+ * Since: 3.22
**/
void
gs_plugin_add_auth (GsPlugin *plugin, GsAuth *auth)
@@ -548,6 +592,8 @@ gs_plugin_add_auth (GsPlugin *plugin, GsAuth *auth)
* Gets a specific authentication object.
*
* Returns: the #GsAuth, or %NULL if not found
+ *
+ * Since: 3.22
**/
GsAuth *
gs_plugin_get_auth_by_id (GsPlugin *plugin, const gchar *provider_id)
@@ -573,6 +619,8 @@ gs_plugin_get_auth_by_id (GsPlugin *plugin, const gchar *provider_id)
* output.
*
* Returns: the #AsProfile
+ *
+ * Since: 3.22
**/
AsProfile *
gs_plugin_get_profile (GsPlugin *plugin)
@@ -587,6 +635,8 @@ gs_plugin_get_profile (GsPlugin *plugin)
* @profile: a #AsProfile
*
* Sets the profile object to be used for the plugin.
+ *
+ * Since: 3.22
**/
void
gs_plugin_set_profile (GsPlugin *plugin, AsProfile *profile)
@@ -602,6 +652,8 @@ gs_plugin_set_profile (GsPlugin *plugin, AsProfile *profile)
* Gets the soup session that plugins can use when downloading.
*
* Returns: the #SoupSession
+ *
+ * Since: 3.22
**/
SoupSession *
gs_plugin_get_soup_session (GsPlugin *plugin)
@@ -616,6 +668,8 @@ gs_plugin_get_soup_session (GsPlugin *plugin)
* @soup_session: a #SoupSession
*
* Sets the soup session that plugins will use when downloading.
+ *
+ * Since: 3.22
**/
void
gs_plugin_set_soup_session (GsPlugin *plugin, SoupSession *soup_session)
@@ -632,6 +686,8 @@ gs_plugin_set_soup_session (GsPlugin *plugin, SoupSession *soup_session)
* Finds out if a plugin has a specific flag set.
*
* Returns: TRUE if the flag is set
+ *
+ * Since: 3.22
**/
gboolean
gs_plugin_has_flags (GsPlugin *plugin, GsPluginFlags flags)
@@ -646,6 +702,8 @@ gs_plugin_has_flags (GsPlugin *plugin, GsPluginFlags flags)
* @running_other: %TRUE if another plugin is running
*
* Inform the plugin that another plugin is running in the loader.
+ *
+ * Since: 3.22
**/
void
gs_plugin_set_running_other (GsPlugin *plugin, gboolean running_other)
@@ -669,6 +727,8 @@ gs_plugin_set_running_other (GsPlugin *plugin, gboolean running_other)
*
* NOTE: The depsolver is iterative and may not solve overly-complicated rules;
* If depsolving fails then gnome-software will not start.
+ *
+ * Since: 3.22
**/
void
gs_plugin_add_rule (GsPlugin *plugin, GsPluginRule rule, const gchar *name)
@@ -685,6 +745,8 @@ gs_plugin_add_rule (GsPlugin *plugin, GsPluginRule rule, const gchar *name)
* Gets the plugin IDs that should be run after this plugin.
*
* Returns: (element-type utf8) (transfer none): the list of plugin names, e.g. ['appstream']
+ *
+ * Since: 3.22
**/
GPtrArray *
gs_plugin_get_rules (GsPlugin *plugin, GsPluginRule rule)
@@ -701,6 +763,8 @@ gs_plugin_get_rules (GsPlugin *plugin, GsPluginRule rule)
* Checks if the distro is compatible.
*
* Returns: %TRUE if compatible
+ *
+ * Since: 3.22
**/
gboolean
gs_plugin_check_distro_id (GsPlugin *plugin, const gchar *distro_id)
@@ -754,6 +818,8 @@ gs_plugin_status_update_cb (gpointer user_data)
* @status: a #GsPluginStatus, e.g. %GS_PLUGIN_STATUS_DOWNLOADING
*
* Update the state of the plugin so any UI can be updated.
+ *
+ * Since: 3.22
**/
void
gs_plugin_status_update (GsPlugin *plugin, GsApp *app, GsPluginStatus status)
@@ -794,6 +860,8 @@ gs_plugin_app_launch_cb (gpointer user_data)
* Launches the application using GAppInfo.
*
* Returns: %TRUE for success
+ *
+ * Since: 3.22
**/
gboolean
gs_plugin_app_launch (GsPlugin *plugin, GsApp *app, GError **error)
@@ -840,6 +908,8 @@ gs_plugin_updates_changed_cb (gpointer user_data)
*
* Emit a signal that tells the plugin loader that the list of updates
* may have changed.
+ *
+ * Since: 3.22
**/
void
gs_plugin_updates_changed (GsPlugin *plugin)
@@ -864,6 +934,8 @@ gs_plugin_reload_cb (gpointer user_data)
* gnashing of teeth.
*
* Plugins should not call this unless absolutely required.
+ *
+ * Since: 3.22
**/
void
gs_plugin_reload (GsPlugin *plugin)
@@ -932,6 +1004,8 @@ gs_plugin_download_chunk_cb (SoupMessage *msg, SoupBuffer *chunk,
* Downloads data.
*
* Returns: the downloaded data, or %NULL
+ *
+ * Since: 3.22
**/
GBytes *
gs_plugin_download_data (GsPlugin *plugin,
@@ -986,6 +1060,8 @@ gs_plugin_download_data (GsPlugin *plugin,
* Downloads data and saves it to a file.
*
* Returns: %TRUE for success
+ *
+ * Since: 3.22
**/
gboolean
gs_plugin_download_file (GsPlugin *plugin,
@@ -1048,6 +1124,8 @@ gs_plugin_download_file (GsPlugin *plugin,
* Looks up an application object from the per-plugin cache
*
* Returns: (transfer full) (nullable): the #GsApp, or %NULL
+ *
+ * Since: 3.22
**/
GsApp *
gs_plugin_cache_lookup (GsPlugin *plugin, const gchar *key)
@@ -1073,6 +1151,8 @@ gs_plugin_cache_lookup (GsPlugin *plugin, const gchar *key)
*
* Adds an application to the per-plugin cache. This is optional,
* and the plugin can use the cache however it likes.
+ *
+ * Since: 3.22
**/
void
gs_plugin_cache_add (GsPlugin *plugin, const gchar *key, GsApp *app)
@@ -1100,6 +1180,8 @@ gs_plugin_cache_add (GsPlugin *plugin, const gchar *key, GsApp *app)
*
* Most plugins do not need to call this funtion; if a suitable cache
* key is being used the old cache item can remain.
+ *
+ * Since: 3.22
**/
void
gs_plugin_cache_invalidate (GsPlugin *plugin)
@@ -1205,6 +1287,8 @@ gs_plugin_init (GsPlugin *plugin)
* Creates a new plugin.
*
* Returns: a #GsPlugin
+ *
+ * Since: 3.22
**/
GsPlugin *
gs_plugin_new (void)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
