diff options
author | Robert Ancell <robert.ancell@canonical.com> | 2017-09-19 13:23:31 +1200 |
---|---|---|
committer | Robert Ancell <robert.ancell@canonical.com> | 2017-09-19 13:23:31 +1200 |
commit | b09754e9be73b72ecee44a257102176ec2ac6827 (patch) | |
tree | e22820d146369b1ef982338b1c31aa11280eb08e /lib | |
parent | 3a0d40174b7014b66964e3bfebb276633a5bac8e (diff) |
Fix gtk-doc errors
Diffstat (limited to 'lib')
46 files changed, 955 insertions, 444 deletions
diff --git a/lib/packagekit-glib2/pk-bitfield.c b/lib/packagekit-glib2/pk-bitfield.c index a712e8e17..9861557ad 100644 --- a/lib/packagekit-glib2/pk-bitfield.c +++ b/lib/packagekit-glib2/pk-bitfield.c @@ -36,6 +36,7 @@ * pk_bitfield_contain_priority: * @values: a valid bitfield instance * @value: the values we are searching for + * @...: * * Finds elements in a list, but with priority going to the preceeding entry * @@ -76,6 +77,7 @@ pk_bitfield_contain_priority (PkBitfield values, gint value, ...) /** * pk_bitfield_from_enums: * @value: the values we want to add to the bitfield + * @...: * * Return value: The return bitfield, or 0 if invalid * diff --git a/lib/packagekit-glib2/pk-category.c b/lib/packagekit-glib2/pk-category.c index 26b7690fa..bd5730862 100644 --- a/lib/packagekit-glib2/pk-category.c +++ b/lib/packagekit-glib2/pk-category.c @@ -64,7 +64,7 @@ G_DEFINE_TYPE (PkCategory, pk_category, PK_TYPE_SOURCE) /** * pk_category_get_parent_id: - * @category: The %PkCategory + * @category: The #PkCategory * * Gets the parent category id. * @@ -81,7 +81,7 @@ pk_category_get_parent_id (PkCategory *category) /** * pk_category_set_parent_id: - * @category: The %PkCategory + * @category: The #PkCategory * @parent_id: the new value * * Sets the parent category id. @@ -98,7 +98,7 @@ pk_category_set_parent_id (PkCategory *category, const gchar *parent_id) /** * pk_category_get_id: - * @category: The %PkCategory + * @category: The #PkCategory * * Gets the id specific to this category. * @@ -115,7 +115,7 @@ pk_category_get_id (PkCategory *category) /** * pk_category_set_id: - * @category: The %PkCategory + * @category: The #PkCategory * @cat_id: the new value * * Sets the id specific to this category. @@ -132,7 +132,7 @@ pk_category_set_id (PkCategory *category, const gchar *cat_id) /** * pk_category_get_name: - * @category: The %PkCategory + * @category: The #PkCategory * * Gets the name. * @@ -149,7 +149,7 @@ pk_category_get_name (PkCategory *category) /** * pk_category_set_name: - * @category: The %PkCategory + * @category: The #PkCategory * @name: the new value * * Sets the name. @@ -166,7 +166,7 @@ pk_category_set_name (PkCategory *category, const gchar *name) /** * pk_category_get_summary: - * @category: The %PkCategory + * @category: The #PkCategory * * Gets the summary. * @@ -183,7 +183,7 @@ pk_category_get_summary (PkCategory *category) /** * pk_category_set_summary: - * @category: The %PkCategory + * @category: The #PkCategory * @summary: the new value * * Sets the summary. @@ -200,7 +200,7 @@ pk_category_set_summary (PkCategory *category, const gchar *summary) /** * pk_category_get_icon: - * @category: The %PkCategory + * @category: The #PkCategory * * Gets the icon filename. * @@ -217,7 +217,7 @@ pk_category_get_icon (PkCategory *category) /** * pk_category_set_icon: - * @category: The %PkCategory + * @category: The #PkCategory * @icon: the new value * * Sets the icon filename. @@ -232,7 +232,7 @@ pk_category_set_icon (PkCategory *category, const gchar *icon) category->priv->icon = g_strdup (icon); } -/** +/* * pk_category_get_property: **/ static void @@ -263,7 +263,7 @@ pk_category_get_property (GObject *object, guint prop_id, GValue *value, GParamS } } -/** +/* * pk_category_set_property: **/ static void @@ -299,7 +299,7 @@ pk_category_set_property (GObject *object, guint prop_id, const GValue *value, G } } -/** +/* * pk_category_class_init: **/ static void @@ -364,7 +364,7 @@ pk_category_class_init (PkCategoryClass *klass) g_type_class_add_private (klass, sizeof (PkCategoryPrivate)); } -/** +/* * pk_category_init: **/ static void @@ -373,7 +373,7 @@ pk_category_init (PkCategory *category) category->priv = PK_CATEGORY_GET_PRIVATE (category); } -/** +/* * pk_category_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-client-helper.c b/lib/packagekit-glib2/pk-client-helper.c index 12f0687de..a723ea8c7 100644 --- a/lib/packagekit-glib2/pk-client-helper.c +++ b/lib/packagekit-glib2/pk-client-helper.c @@ -153,7 +153,7 @@ out: return ret; } -/** +/* * pk_client_helper_copy_stdout_cb: **/ static gboolean @@ -221,7 +221,7 @@ pk_client_helper_copy_stdout_cb (GIOChannel *source, GIOCondition condition, PkC return TRUE; } -/** +/* * pk_client_helper_echo_stderr_cb: **/ static gboolean @@ -252,7 +252,7 @@ out: return ret; } -/** +/* * pk_client_helper_copy_conn_cb: **/ static gboolean @@ -307,7 +307,7 @@ pk_client_helper_copy_conn_cb (GIOChannel *source, GIOCondition condition, PkCli return TRUE; } -/** +/* * pk_client_helper_accept_connection_cb: **/ static gboolean @@ -504,7 +504,7 @@ pk_client_helper_start (PkClientHelper *client_helper, return TRUE; } -/** +/* * pk_client_helper_class_init: **/ static void @@ -515,7 +515,7 @@ pk_client_helper_class_init (PkClientHelperClass *klass) g_type_class_add_private (klass, sizeof (PkClientHelperPrivate)); } -/** +/* * pk_client_helper_init: **/ static void @@ -524,7 +524,7 @@ pk_client_helper_init (PkClientHelper *client_helper) client_helper->priv = PK_CLIENT_HELPER_GET_PRIVATE (client_helper); } -/** +/* * pk_client_helper_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-client-sync.c b/lib/packagekit-glib2/pk-client-sync.c index a6b1a4b4a..d40ab7093 100644 --- a/lib/packagekit-glib2/pk-client-sync.c +++ b/lib/packagekit-glib2/pk-client-sync.c @@ -39,7 +39,7 @@ typedef struct { PkProgress *progress; } PkClientHelper; -/** +/* * pk_client_generic_finish_sync: **/ static void @@ -57,21 +57,21 @@ pk_client_generic_finish_sync (PkClient *client, GAsyncResult *res, PkClientHelp /** * pk_client_resolve: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @packages: (array zero-terminated=1): an array of package names to resolve, e.g. "gnome-system-tools" * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope call): the function to run when the progress changes * @progress_user_data: data to pass to @progress_callback * @error: the #GError to store any failure, or %NULL * - * Resolve a package name into a %package_id. This can return installed and + * Resolve a package name into a @package_id. This can return installed and * available packages and allows you find out if a package is installed locally * or is available in a repository. * * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -113,7 +113,7 @@ pk_client_resolve (PkClient *client, PkBitfield filters, gchar **packages, GCanc /** * pk_client_search_names: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @values: (array zero-terminated=1): free text to search for, for instance, "power" * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope call): the function to run when the progress changes @@ -126,7 +126,7 @@ pk_client_resolve (PkClient *client, PkBitfield filters, gchar **packages, GCanc * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.5 **/ @@ -168,7 +168,7 @@ pk_client_search_names (PkClient *client, PkBitfield filters, gchar **values, GC /** * pk_client_search_details: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @values: (array zero-terminated=1): free text to search for, for instance, "power" * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope call): the function to run when the progress changes @@ -182,7 +182,7 @@ pk_client_search_names (PkClient *client, PkBitfield filters, gchar **values, GC * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.5 **/ @@ -224,7 +224,7 @@ pk_client_search_details (PkClient *client, PkBitfield filters, gchar **values, /** * pk_client_search_groups: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @values: (array zero-terminated=1): a group enum to search for, for instance, "system-tools" * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope call): the function to run when the progress changes @@ -236,7 +236,7 @@ pk_client_search_details (PkClient *client, PkBitfield filters, gchar **values, * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.5 **/ @@ -278,7 +278,7 @@ pk_client_search_groups (PkClient *client, PkBitfield filters, gchar **values, G /** * pk_client_search_files: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @values: (array zero-terminated=1): file to search for, for instance, "/sbin/service" * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope call): the function to run when the progress changes @@ -290,7 +290,7 @@ pk_client_search_groups (PkClient *client, PkBitfield filters, gchar **values, G * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.5 **/ @@ -344,7 +344,7 @@ pk_client_search_files (PkClient *client, PkBitfield filters, gchar **values, GC * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -398,7 +398,7 @@ pk_client_get_details (PkClient *client, gchar **package_ids, GCancellable *canc * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.8.17 **/ @@ -454,7 +454,7 @@ pk_client_get_details_local (PkClient *client, gchar **files, GCancellable *canc * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.9.1 **/ @@ -510,7 +510,7 @@ pk_client_get_files_local (PkClient *client, gchar **files, GCancellable *cancel * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -564,7 +564,7 @@ pk_client_get_update_detail (PkClient *client, gchar **package_ids, GCancellable * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -606,7 +606,7 @@ pk_client_download_packages (PkClient *client, gchar **package_ids, const gchar /** * pk_client_get_updates: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_DEVEL or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_DEVELOPMENT or %PK_FILTER_ENUM_NONE * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope call): the function to run when the progress changes * @progress_user_data: data to pass to @progress_callback @@ -617,7 +617,7 @@ pk_client_download_packages (PkClient *client, gchar **package_ids, const gchar * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -670,7 +670,7 @@ pk_client_get_updates (PkClient *client, PkBitfield filters, GCancellable *cance * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -712,7 +712,7 @@ pk_client_get_old_transactions (PkClient *client, guint number, GCancellable *ca /** * pk_client_depends_on: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @package_ids: (array zero-terminated=1): a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora" * @recursive: If we should search recursively for depends * @cancellable: a #GCancellable or %NULL @@ -725,7 +725,7 @@ pk_client_get_old_transactions (PkClient *client, guint number, GCancellable *ca * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -767,7 +767,7 @@ pk_client_depends_on (PkClient *client, PkBitfield filters, gchar **package_ids, /** * pk_client_get_packages: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope call): the function to run when the progress changes * @progress_user_data: data to pass to @progress_callback @@ -778,7 +778,7 @@ pk_client_depends_on (PkClient *client, PkBitfield filters, gchar **package_ids, * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -820,7 +820,7 @@ pk_client_get_packages (PkClient *client, PkBitfield filters, GCancellable *canc /** * pk_client_required_by: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @package_ids: (array zero-terminated=1): a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora" * @recursive: If we should search recursively for requires * @cancellable: a #GCancellable or %NULL @@ -833,7 +833,7 @@ pk_client_get_packages (PkClient *client, PkBitfield filters, GCancellable *canc * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -875,7 +875,7 @@ pk_client_required_by (PkClient *client, PkBitfield filters, gchar **package_ids /** * pk_client_what_provides: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @values: (array zero-terminated=1): a search term such as "sound/mp3" * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope call): the function to run when the progress changes @@ -889,7 +889,7 @@ pk_client_required_by (PkClient *client, PkBitfield filters, gchar **package_ids * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -945,7 +945,7 @@ pk_client_what_provides (PkClient *client, * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -998,7 +998,7 @@ pk_client_get_distro_upgrades (PkClient *client, GCancellable *cancellable, * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -1050,7 +1050,7 @@ pk_client_get_files (PkClient *client, gchar **package_ids, GCancellable *cancel * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -1102,13 +1102,13 @@ pk_client_get_categories (PkClient *client, GCancellable *cancellable, * @error: the #GError to store any failure, or %NULL * * Remove a package (optionally with dependancies) from the system. - * If %allow_deps is set to %FALSE, and other packages would have to be removed, + * If @allow_deps is set to %FALSE, and other packages would have to be removed, * then the transaction would fail. * * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.8.1 **/ @@ -1179,7 +1179,7 @@ pk_client_remove_packages (PkClient *client, * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -1233,7 +1233,7 @@ pk_client_refresh_cache (PkClient *client, gboolean force, GCancellable *cancell * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.8.1 **/ @@ -1293,7 +1293,7 @@ pk_client_install_packages (PkClient *client, * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -1347,7 +1347,7 @@ pk_client_install_signature (PkClient *client, PkSigTypeEnum type, const gchar * * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.8.1 **/ @@ -1407,7 +1407,7 @@ pk_client_update_packages (PkClient *client, * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.8.1 **/ @@ -1465,7 +1465,7 @@ pk_client_install_files (PkClient *client, * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -1507,7 +1507,7 @@ pk_client_accept_eula (PkClient *client, const gchar *eula_id, GCancellable *can /** * pk_client_get_repo_list: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_DEVEL or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_DEVELOPMENT or %PK_FILTER_ENUM_NONE * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope call): the function to run when the progress changes * @progress_user_data: data to pass to @progress_callback @@ -1518,7 +1518,7 @@ pk_client_accept_eula (PkClient *client, const gchar *eula_id, GCancellable *can * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -1572,7 +1572,7 @@ pk_client_get_repo_list (PkClient *client, PkBitfield filters, GCancellable *can * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -1628,7 +1628,7 @@ pk_client_repo_enable (PkClient *client, const gchar *repo_id, gboolean enabled, * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -1683,7 +1683,7 @@ pk_client_repo_set_data (PkClient *client, const gchar *repo_id, const gchar *pa * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.9.1 **/ @@ -1737,7 +1737,9 @@ pk_client_repo_remove (PkClient *client, /** * pk_client_upgrade_system: + * @client: a valid #PkClient instance * @distro_id: a distro ID such as "fedora-14" + * @transaction_flags: transaction flags * @upgrade_kind: a #PkUpgradeKindEnum such as %PK_UPGRADE_KIND_ENUM_COMPLETE * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope call): the function to run when the progress changes @@ -1753,7 +1755,7 @@ pk_client_repo_remove (PkClient *client, * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 1.0.10 **/ @@ -1797,6 +1799,7 @@ pk_client_upgrade_system (PkClient *client, PkBitfield transaction_flags, /** * pk_client_repair_system: + * @client: a valid #PkClient instance * @transaction_flags: if only trusted packages should be installed * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope call): the function to run when the progress changes @@ -1813,7 +1816,7 @@ pk_client_upgrade_system (PkClient *client, PkBitfield transaction_flags, * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.8.1 **/ @@ -1875,7 +1878,7 @@ pk_client_repair_system (PkClient *client, * Warning: this function is synchronous, and will block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -1914,7 +1917,7 @@ pk_client_adopt (PkClient *client, const gchar *transaction_id, GCancellable *ca return results; } -/** +/* * pk_client_get_progress_finish_sync: **/ static void @@ -1941,7 +1944,7 @@ pk_client_get_progress_finish_sync (PkClient *client, GAsyncResult *res, PkClien * Warning: this function is synchronous, and will block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ diff --git a/lib/packagekit-glib2/pk-client.c b/lib/packagekit-glib2/pk-client.c index 9911e4a85..b1c06ee66 100644 --- a/lib/packagekit-glib2/pk-client.c +++ b/lib/packagekit-glib2/pk-client.c @@ -137,13 +137,15 @@ pk_client_signal_cb (GDBusProxy *proxy, /** * pk_client_error_quark: * - * Return value: Our personal error quark. + * An error quark for #PkClientError. + * + * Return value: an error quark. * * Since: 0.5.2 **/ G_DEFINE_QUARK (pk-client-error-quark, pk_client_error) -/** +/* * pk_client_get_property: **/ static void @@ -174,7 +176,7 @@ pk_client_get_property (GObject *object, guint prop_id, GValue *value, GParamSpe } } -/** +/* * pk_client_set_property: **/ static void @@ -203,7 +205,7 @@ pk_client_set_property (GObject *object, guint prop_id, const GValue *value, GPa } } -/** +/* * pk_client_fixup_dbus_error: **/ static void @@ -263,7 +265,7 @@ pk_client_fixup_dbus_error (GError *error) g_warning ("couldn't parse execption '%s', please report", name); } -/** +/* * pk_client_real_path: * * Resolves paths like ../../Desktop/bar.rpm to /home/hughsie/Desktop/bar.rpm @@ -299,7 +301,7 @@ pk_client_real_path (const gchar *path) return real; } -/** +/* * pk_client_convert_real_paths: **/ static gchar ** @@ -327,7 +329,7 @@ pk_client_convert_real_paths (gchar **paths, GError **error) return g_strdupv (res); } -/** +/* * pk_client_get_user_temp: * * Return (and create if does not exist) a temporary directory @@ -358,7 +360,7 @@ pk_client_get_user_temp (const gchar *subfolder, GError **error) return path; } -/** +/* * pk_client_is_file_native: **/ static gboolean @@ -377,7 +379,7 @@ pk_client_is_file_native (const gchar *filename) return TRUE; } -/** +/* * pk_client_percentage_to_signed: */ static gint @@ -388,7 +390,7 @@ pk_client_percentage_to_signed (guint percentage) return (gint) percentage; } -/** +/* * pk_client_set_property_value: **/ static void @@ -551,7 +553,7 @@ pk_client_set_property_value (PkClientState *state, g_warning ("unhandled property '%s'", key); } -/** +/* * pk_client_cancel_cb: **/ static void @@ -576,7 +578,7 @@ pk_client_cancel_cb (GObject *source_object, g_debug ("cancelled %s", state->tid); } -/** +/* * pk_client_cancellable_cancel_cb: **/ static void @@ -598,7 +600,7 @@ pk_client_cancellable_cancel_cb (GCancellable *cancellable, PkClientState *state pk_client_cancel_cb, state); } -/** +/* * pk_client_state_remove: **/ static void @@ -615,7 +617,7 @@ pk_client_state_remove (PkClient *client, PkClientState *state) } } -/** +/* * pk_client_state_add: **/ static void @@ -633,7 +635,7 @@ pk_client_state_add (PkClient *client, PkClientState *state) } } -/** +/* * pk_client_state_finish: **/ static void @@ -714,7 +716,7 @@ pk_client_state_finish (PkClientState *state, const GError *error) g_slice_free (PkClientState, state); } -/** +/* * pk_client_properties_changed_cb: **/ static void @@ -738,7 +740,7 @@ pk_client_properties_changed_cb (GDBusProxy *proxy, } } -/** +/* * pk_client_signal_package: */ static void @@ -799,7 +801,7 @@ pk_client_signal_package (PkClientState *state, } } -/** +/* * pk_client_copy_finished_remove_old_files: * * Removes all the files that do not have the prefix destination path. @@ -833,7 +835,7 @@ pk_client_copy_finished_remove_old_files (PkClientState *state) } } -/** +/* * pk_client_copy_downloaded_finished_cb: */ static void @@ -860,7 +862,7 @@ pk_client_copy_downloaded_finished_cb (GFile *file, GAsyncResult *res, PkClientS } } -/** +/* * pk_client_copy_progress_cb: */ static void @@ -890,7 +892,7 @@ pk_client_copy_progress_cb (goffset current_num_bytes, goffset total_num_bytes, } } -/** +/* * pk_client_copy_downloaded_file: */ static void @@ -937,7 +939,7 @@ pk_client_copy_downloaded_file (PkClientState *state, const gchar *package_id, c pk_results_add_files (state->results, item); } -/** +/* * pk_client_copy_downloaded: * * We have to copy the files from the temporary directory into the user-specified @@ -991,7 +993,7 @@ pk_client_copy_downloaded (PkClientState *state) } } -/** +/* * pk_client_signal_finished: */ static void @@ -1039,7 +1041,7 @@ pk_client_signal_finished (PkClientState *state, pk_client_state_finish (state, NULL); } -/** +/* * pk_client_signal_cb: **/ static void @@ -1391,7 +1393,7 @@ pk_client_signal_cb (GDBusProxy *proxy, return; } -/** +/* * pk_client_proxy_connect: **/ static void @@ -1420,7 +1422,7 @@ pk_client_proxy_connect (PkClientState *state) state); } -/** +/* * pk_client_method_cb: **/ static void @@ -1445,7 +1447,7 @@ pk_client_method_cb (GObject *source_object, /* wait for ::Finished() */ } -/** +/* * pk_client_set_role: **/ static void @@ -1463,7 +1465,7 @@ pk_client_set_role (PkClientState *state, PkRoleEnum role) return; } -/** +/* * pk_client_set_hints_cb: **/ static void @@ -1851,7 +1853,7 @@ pk_client_set_hints_cb (GObject *source_object, } } -/** +/* * pk_client_bool_to_string: **/ static const gchar * @@ -1862,7 +1864,7 @@ pk_client_bool_to_string (gboolean value) return "false"; } -/** +/* * pk_client_create_helper_argv_envp_test: **/ static gboolean @@ -1888,7 +1890,7 @@ pk_client_create_helper_argv_envp_test (PkClientState *state, return TRUE; } -/** +/* * pk_client_create_helper_argv_envp: **/ static gboolean @@ -1945,7 +1947,7 @@ pk_client_create_helper_argv_envp (PkClientState *state, return TRUE; } -/** +/* * pk_client_create_helper_socket: **/ static gchar * @@ -1994,7 +1996,7 @@ pk_client_create_helper_socket (PkClientState *state) return g_strdup_printf ("frontend-socket=%s", socket_filename); } -/** +/* * pk_client_get_proxy_cb: **/ static void @@ -2065,7 +2067,7 @@ pk_client_get_proxy_cb (GObject *object, g_ptr_array_add (state->client->priv->calls, state); } -/** +/* * pk_client_get_tid_cb: **/ static void @@ -2125,7 +2127,7 @@ pk_client_generic_finish (PkClient *client, GAsyncResult *res, GError **error) /** * pk_client_resolve_async: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @packages: (array zero-terminated=1): an array of package names to resolve, e.g. "gnome-system-tools" * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope notified): the function to run when the progress changes @@ -2133,7 +2135,7 @@ pk_client_generic_finish (PkClient *client, GAsyncResult *res, GError **error) * @callback_ready: the function to run on completion * @user_data: the data to pass to @callback_ready * - * Resolve a package name into a %package_id. This can return installed and + * Resolve a package name into a @package_id. This can return installed and * available packages and allows you find out if a package is installed locally * or is available in a repository. * @@ -2193,7 +2195,7 @@ pk_client_resolve_async (PkClient *client, PkBitfield filters, gchar **packages, /** * pk_client_search_names_async: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @values: (array zero-terminated=1): free text to search for, for instance, "power" * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope notified): the function to run when the progress changes @@ -2260,7 +2262,7 @@ pk_client_search_names_async (PkClient *client, PkBitfield filters, gchar **valu /** * pk_client_search_details_async: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @values: (array zero-terminated=1): free text to search for, for instance, "power" * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope notified): the function to run when the progress changes @@ -2328,7 +2330,7 @@ pk_client_search_details_async (PkClient *client, PkBitfield filters, gchar **va /** * pk_client_search_groups_async: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @values: (array zero-terminated=1): a group enum to search for, for instance, "system-tools" * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope notified): the function to run when the progress changes @@ -2394,7 +2396,7 @@ pk_client_search_groups_async (PkClient *client, PkBitfield filters, gchar **val /** * pk_client_search_files_async: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @values: (array zero-terminated=1): file to search for, for instance, "/sbin/service" * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope notified): the function to run when the progress changes @@ -2799,7 +2801,7 @@ pk_client_download_packages_async (PkClient *client, gchar **package_ids, const /** * pk_client_get_updates_async: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_DEVEL or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_DEVELOPMENT or %PK_FILTER_ENUM_NONE * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope notified): the function to run when the progress changes * @progress_user_data: data to pass to @progress_callback @@ -2927,7 +2929,7 @@ pk_client_get_old_transactions_async (PkClient *client, guint number, GCancellab /** * pk_client_depends_on_async: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @package_ids: (array zero-terminated=1): a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora" * @recursive: If we should search recursively for depends * @cancellable: a #GCancellable or %NULL @@ -2996,7 +2998,7 @@ pk_client_depends_on_async (PkClient *client, PkBitfield filters, gchar **packag /** * pk_client_get_packages_async: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope notified): the function to run when the progress changes * @progress_user_data: data to pass to @progress_callback @@ -3060,7 +3062,7 @@ pk_client_get_packages_async (PkClient *client, PkBitfield filters, GCancellable /** * pk_client_required_by_async: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @package_ids: (array zero-terminated=1): a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora" * @recursive: If we should search recursively for requires * @cancellable: a #GCancellable or %NULL @@ -3129,7 +3131,7 @@ pk_client_required_by_async (PkClient *client, PkBitfield filters, gchar **packa /** * pk_client_what_provides_async: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_GUI | %PK_FILTER_ENUM_FREE or %PK_FILTER_ENUM_NONE * @values: (array zero-terminated=1): a search term such as "sound/mp3" * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope notified): the function to run when the progress changes @@ -3401,7 +3403,7 @@ pk_client_get_categories_async (PkClient *client, GCancellable *cancellable, * @user_data: the data to pass to @callback_ready * * Remove a package (optionally with dependancies) from the system. - * If %allow_deps is set to %FALSE, and other packages would have to be removed, + * If @allow_deps is set to %FALSE, and other packages would have to be removed, * then the transaction would fail. * * Since: 0.8.1 @@ -3741,7 +3743,7 @@ pk_client_update_packages_async (PkClient *client, state); } -/** +/* * pk_client_copy_native_finished_cb: */ static void @@ -3765,7 +3767,7 @@ pk_client_copy_native_finished_cb (GFile *file, GAsyncResult *res, PkClientState } } -/** +/* * pk_client_copy_non_native_then_get_tid: **/ static void @@ -3979,7 +3981,7 @@ pk_client_accept_eula_async (PkClient *client, const gchar *eula_id, GCancellabl /** * pk_client_get_repo_list_async: * @client: a valid #PkClient instance - * @filters: a %PkBitfield such as %PK_FILTER_ENUM_DEVEL or %PK_FILTER_ENUM_NONE + * @filters: a #PkBitfield such as %PK_FILTER_ENUM_DEVELOPMENT or %PK_FILTER_ENUM_NONE * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope notified): the function to run when the progress changes * @progress_user_data: data to pass to @progress_callback @@ -4391,7 +4393,7 @@ pk_client_repair_system_async (PkClient *client, /**********************************************************************/ -/** +/* * pk_client_adopt_get_proxy_cb: **/ static void @@ -4524,7 +4526,7 @@ pk_client_get_progress_finish (PkClient *client, GAsyncResult *res, GError **err return g_object_ref (g_simple_async_result_get_op_res_gpointer (simple)); } -/** +/* * pk_client_get_progress_state_finish: **/ static void @@ -4572,7 +4574,7 @@ pk_client_get_progress_state_finish (PkClientState *state, const GError *error) g_slice_free (PkClientState, state); } -/** +/* * pk_client_get_progress_cb: **/ static void @@ -4667,7 +4669,7 @@ pk_client_get_progress_async (PkClient *client, /**********************************************************************/ -/** +/* * pk_client_cancel_all_dbus_methods: **/ static gboolean @@ -4847,7 +4849,7 @@ pk_client_get_cache_age (PkClient *client) return client->priv->cache_age; } -/** +/* * pk_client_class_init: **/ static void @@ -4912,7 +4914,7 @@ pk_client_class_init (PkClientClass *klass) g_object_class_install_property (object_class, PROP_CACHE_AGE, pspec); } -/** +/* * pk_client_init: **/ static void @@ -4932,7 +4934,7 @@ pk_client_init (PkClient *client) client->priv->locale = g_strdup (setlocale (LC_MESSAGES, NULL)); } -/** +/* * pk_client_finalize: **/ static void @@ -4957,7 +4959,7 @@ pk_client_finalize (GObject *object) * PkClient is a nice GObject wrapper for PackageKit and makes writing * frontends easy. * - * Return value: A new %PkClient instance + * Return value: A new #PkClient instance * * Since: 0.5.2 **/ diff --git a/lib/packagekit-glib2/pk-client.h b/lib/packagekit-glib2/pk-client.h index 4aa11b854..c825afc03 100644 --- a/lib/packagekit-glib2/pk-client.h +++ b/lib/packagekit-glib2/pk-client.h @@ -48,13 +48,16 @@ G_BEGIN_DECLS /** * PkClientError: * @PK_CLIENT_ERROR_FAILED: the transaction failed for an unknown reason + * @PK_CLIENT_ERROR_FAILED_AUTH: the transaction failed authentication/authorization * @PK_CLIENT_ERROR_NO_TID: the transaction id was not pre-allocated (internal error) * @PK_CLIENT_ERROR_ALREADY_TID: the transaction id has already been used (internal error) * @PK_CLIENT_ERROR_ROLE_UNKNOWN: the role was not set (internal error) + * @PK_CLIENT_ERROR_CANNOT_START_DAEMON: the PackageKit daemon failed to start * @PK_CLIENT_ERROR_INVALID_INPUT: the package_id is invalid * @PK_CLIENT_ERROR_INVALID_FILE: the file is invalid * @PK_CLIENT_ERROR_NOT_SUPPORTED: the action is not supported * @PK_CLIENT_ERROR_DECLINED_SIMULATION: the simulation was declined by the user + * @PK_CLIENT_ERROR_LAST: * * Errors that can be thrown */ diff --git a/lib/packagekit-glib2/pk-common.c b/lib/packagekit-glib2/pk-common.c index e4c9cdc0f..c51cb5864 100644 --- a/lib/packagekit-glib2/pk-common.c +++ b/lib/packagekit-glib2/pk-common.c @@ -41,6 +41,8 @@ /** * pk_iso8601_present: + * + * Get the current date / time as an ISO8601 string. * * Return value: The current iso8601 date and time * @@ -61,9 +63,11 @@ pk_iso8601_present (void) /** * pk_iso8601_from_date: - * @date: a %GDate to convert + * @date: a #GDate to convert * - * Return value: If valid then a new ISO8601 date, else NULL + * Convert a date into an ISO8601 data string. + * + * Return value: If valid then a new ISO8601 date, else %NULL * * Since: 0.5.2 **/ @@ -208,8 +212,10 @@ pk_ptr_array_to_strv (GPtrArray *array) /** * pk_get_machine_type: * - * Return value: The current machine ID, e.g. "i386" + * Get the machine type for the current host, e.g. "i386" * Note: Don't use this function if you can get this data from /etc/foo + * + * Return value: a machine type **/ static gchar * pk_get_distro_id_machine_type (void) @@ -223,7 +229,7 @@ pk_get_distro_id_machine_type (void) return g_strdup (buf.machine); } -/** +/* * pk_parse_os_release: * * Internal helper to parse os-release @@ -274,7 +280,9 @@ pk_parse_os_release (gchar **id, gchar **name, gchar **version_id, GError **erro /** * pk_get_distro_id: * - * Return value: the distro-id, typically "distro;version;arch" + * Get the distribution ID for the current host, typically "distro;version;arch" + * + * Return value: a distribution ID **/ gchar * pk_get_distro_id (void) @@ -301,8 +309,11 @@ pk_get_distro_id (void) /** * pk_get_distro_name: + * @error: the #GError to store any failure, or %NULL + * + * Get the distribution name for this host as specified by NAME in /etc/os-release, e.g. "Fedora", * - * Return value: the distro name, e.g. "Fedora", as specified by NAME in /etc/os-release + * Return value: a distro name **/ gchar * pk_get_distro_name (GError **error) @@ -319,8 +330,11 @@ pk_get_distro_name (GError **error) /** * pk_get_distro_version_id: + * @error: the #GError to store any failure, or %NULL + * + * Get the distribution version ID as specified by VERSION_ID in /etc/os-release, e.g. "23" * - * Return value: the distro version, e.g. "23", as specified by VERSION_ID in /etc/os-release + * Return value: a distribution version **/ gchar * pk_get_distro_version_id (GError **error) diff --git a/lib/packagekit-glib2/pk-console-shared.c b/lib/packagekit-glib2/pk-console-shared.c index 5810e160a..9ff4e3134 100644 --- a/lib/packagekit-glib2/pk-console-shared.c +++ b/lib/packagekit-glib2/pk-console-shared.c @@ -39,6 +39,12 @@ /** * pk_console_get_number: + * @question: question to ask user + * @maxnum: maximum number allowed + * + * Get a number from the console. + * + * Return value: a number entered by the user. **/ guint pk_console_get_number (const gchar *question, guint maxnum) @@ -70,7 +76,7 @@ pk_console_get_number (const gchar *question, guint maxnum) } -/** +/* * pk_readline_unbuffered: **/ static GString * @@ -131,6 +137,12 @@ out: /** * pk_console_get_prompt: + * @question: question to ask user + * @defaultyes: %TRUE if the default answer is yes + * + * Prompt the user with a yes/no question. + * + * Return value: %TRUE if the user accepted the question. **/ gboolean pk_console_get_prompt (const gchar *question, gboolean defaultyes) @@ -174,6 +186,11 @@ pk_console_get_prompt (const gchar *question, gboolean defaultyes) /** * pk_status_enum_to_localised_text: + * @status: a #PkStatusEnum + * + * Convert a #PkStatusEnum to a localized string suitable for showing to a user. + * + * Return value: a localized string. **/ const gchar * pk_status_enum_to_localised_text (PkStatusEnum status) diff --git a/lib/packagekit-glib2/pk-control-sync.c b/lib/packagekit-glib2/pk-control-sync.c index e25ef1d0f..eb6912c39 100644 --- a/lib/packagekit-glib2/pk-control-sync.c +++ b/lib/packagekit-glib2/pk-control-sync.c @@ -40,7 +40,7 @@ typedef struct { gchar **transaction_list; } PkControlHelper; -/** +/* * pk_control_get_properties_cb: **/ static void @@ -97,7 +97,7 @@ pk_control_get_properties (PkControl *control, GCancellable *cancellable, GError return ret; } -/** +/* * pk_control_get_transaction_list_cb: **/ static void @@ -154,7 +154,7 @@ pk_control_get_transaction_list (PkControl *control, GCancellable *cancellable, return transaction_list; } -/** +/* * pk_control_suggest_daemon_quit_cb: **/ static void @@ -211,7 +211,7 @@ pk_control_suggest_daemon_quit (PkControl *control, GCancellable *cancellable, G return ret; } -/** +/* * pk_control_set_proxy_cb: **/ static void diff --git a/lib/packagekit-glib2/pk-control.c b/lib/packagekit-glib2/pk-control.c index e84f1d07f..efd9be88e 100644 --- a/lib/packagekit-glib2/pk-control.c +++ b/lib/packagekit-glib2/pk-control.c @@ -174,7 +174,7 @@ _g_strvcmp0 (gchar **one, gchar **two) return TRUE; } -/** +/* * pk_control_set_property_value: **/ static void @@ -311,7 +311,7 @@ pk_control_set_property_value (PkControl *control, g_warning ("unhandled property '%s'", key); } -/** +/* * pk_control_properties_changed_cb: **/ static void @@ -335,7 +335,7 @@ pk_control_properties_changed_cb (GDBusProxy *proxy, } } -/** +/* * pk_control_signal_cb: **/ static void @@ -378,7 +378,7 @@ pk_control_signal_cb (GDBusProxy *proxy, } } -/** +/* * pk_control_proxy_connect: **/ static void @@ -412,7 +412,7 @@ pk_control_proxy_connect (PkControlState *state) /**********************************************************************/ -/** +/* * pk_control_get_tid_state_finish: **/ static void @@ -447,7 +447,7 @@ pk_control_get_tid_state_finish (PkControlState *state, const GError *error) g_slice_free (PkControlState, state); } -/** +/* * pk_control_get_tid_cb: **/ static void @@ -476,7 +476,7 @@ pk_control_get_tid_cb (GObject *source_object, pk_control_get_tid_state_finish (state, NULL); } -/** +/* * pk_control_get_tid_internal: **/ static void @@ -492,7 +492,7 @@ pk_control_get_tid_internal (PkControlState *state) state); } -/** +/* * pk_control_get_tid_proxy_cb: **/ static void @@ -613,7 +613,7 @@ pk_control_get_tid_finish (PkControl *control, /**********************************************************************/ -/** +/* * pk_control_suggest_daemon_quit_state_finish: **/ static void @@ -647,7 +647,7 @@ pk_control_suggest_daemon_quit_state_finish (PkControlState *state, g_slice_free (PkControlState, state); } -/** +/* * pk_control_suggest_daemon_quit_cb: **/ static void @@ -674,7 +674,7 @@ pk_control_suggest_daemon_quit_cb (GObject *source_object, pk_control_suggest_daemon_quit_state_finish (state, NULL); } -/** +/* * pk_control_suggest_daemon_quit_internal: **/ static void @@ -690,7 +690,7 @@ pk_control_suggest_daemon_quit_internal (PkControlState *state) state); } -/** +/* * pk_control_suggest_daemon_quit_proxy_cb: **/ static void @@ -809,7 +809,7 @@ pk_control_suggest_daemon_quit_finish (PkControl *control, GAsyncResult *res, GE /**********************************************************************/ -/** +/* * pk_control_get_daemon_state_state_finish: **/ static void @@ -843,7 +843,7 @@ pk_control_get_daemon_state_state_finish (PkControlState *state, const GError *e g_slice_free (PkControlState, state); } -/** +/* * pk_control_get_daemon_state_cb: **/ static void @@ -872,7 +872,7 @@ pk_control_get_daemon_state_cb (GObject *source_object, pk_control_get_daemon_state_state_finish (state, NULL); } -/** +/* * pk_control_get_daemon_state_internal: **/ static void @@ -888,7 +888,7 @@ pk_control_get_daemon_state_internal (PkControlState *state) state); } -/** +/* * pk_control_get_daemon_state_proxy_cb: **/ static void @@ -1009,7 +1009,7 @@ pk_control_get_daemon_state_finish (PkControl *control, /**********************************************************************/ -/** +/* * pk_control_set_proxy_state_finish: **/ static void @@ -1044,7 +1044,7 @@ pk_control_set_proxy_state_finish (PkControlState *state, g_slice_free (PkControlState, state); } -/** +/* * pk_control_set_proxy_cb: **/ static void @@ -1072,7 +1072,7 @@ pk_control_set_proxy_cb (GObject *source_object, pk_control_set_proxy_state_finish (state, NULL); } -/** +/* * pk_control_set_proxy_internal: **/ static void @@ -1088,7 +1088,7 @@ pk_control_set_proxy_internal (PkControlState *state) state); } -/** +/* * pk_control_set_proxy_proxy_cb: **/ static void @@ -1264,7 +1264,7 @@ pk_control_set_proxy_finish (PkControl *control, /**********************************************************************/ -/** +/* * pk_control_get_transaction_list_state_finish: **/ static void @@ -1300,7 +1300,7 @@ pk_control_get_transaction_list_state_finish (PkControlState *state, g_slice_free (PkControlState, state); } -/** +/* * pk_control_get_transaction_list_cb: **/ static void @@ -1336,7 +1336,7 @@ pk_control_get_transaction_list_cb (GObject *source_object, pk_control_get_transaction_list_state_finish (state, NULL); } -/** +/* * pk_control_get_transaction_list_internal: **/ static void @@ -1352,7 +1352,7 @@ pk_control_get_transaction_list_internal (PkControlState *state) state); } -/** +/* * pk_control_get_transaction_list_proxy_cb: **/ static void @@ -1473,7 +1473,7 @@ pk_control_get_transaction_list_finish (PkControl *control, /**********************************************************************/ -/** +/* * pk_control_get_time_since_action_state_finish: **/ static void @@ -1507,7 +1507,7 @@ pk_control_get_time_since_action_state_finish (PkControlState *state, g_slice_free (PkControlState, state); } -/** +/* * pk_control_get_time_since_action_cb: **/ static void @@ -1541,7 +1541,7 @@ pk_control_get_time_since_action_cb (GObject *source_object, pk_control_get_time_since_action_state_finish (state, NULL); } -/** +/* * pk_control_get_time_since_action_internal: **/ static void @@ -1557,7 +1557,7 @@ pk_control_get_time_since_action_internal (PkControlState *state) state); } -/** +/* * pk_control_get_time_since_action_proxy_cb: **/ static void @@ -1683,7 +1683,7 @@ pk_control_get_time_since_action_finish (PkControl *control, /**********************************************************************/ -/** +/* * pk_control_can_authorize_state_finish: **/ static void @@ -1716,7 +1716,7 @@ pk_control_can_authorize_state_finish (PkControlState *state, const GError *erro g_slice_free (PkControlState, state); } -/** +/* * pk_control_can_authorize_cb: **/ static void @@ -1750,7 +1750,7 @@ pk_control_can_authorize_cb (GObject *source_object, pk_control_can_authorize_state_finish (state, NULL); } -/** +/* * pk_control_can_authorize_internal: **/ static void @@ -1766,7 +1766,7 @@ pk_control_can_authorize_internal (PkControlState *state) state); } -/** +/* * pk_control_can_authorize_proxy_cb: **/ static void @@ -1863,7 +1863,7 @@ pk_control_can_authorize_async (PkControl *control, * * Gets the result from the asynchronous function. * - * Return value: the %PkAuthorizeEnum or %PK_AUTHORIZE_ENUM_UNKNOWN if the method failed + * Return value: the #PkAuthorizeEnum or %PK_AUTHORIZE_ENUM_UNKNOWN if the method failed * * Since: 0.5.2 **/ @@ -1890,7 +1890,7 @@ pk_control_can_authorize_finish (PkControl *control, GAsyncResult *res, GError * /**********************************************************************/ -/** +/* * pk_control_get_properties_state_finish: **/ static void @@ -1923,7 +1923,7 @@ pk_control_get_properties_state_finish (PkControlState *state, const GError *err g_slice_free (PkControlState, state); } -/** +/* * pk_control_get_properties_cb: **/ static void @@ -2051,7 +2051,7 @@ pk_control_get_properties_finish (PkControl *control, GAsyncResult *res, GError /**********************************************************************/ -/** +/* * pk_control_get_property: **/ static void @@ -2112,7 +2112,7 @@ pk_control_get_property (GObject *object, guint prop_id, GValue *value, GParamSp } } -/** +/* * pk_control_set_property: **/ static void @@ -2125,7 +2125,7 @@ pk_control_set_property (GObject *object, guint prop_id, const GValue *value, GP } } -/** +/* * pk_control_class_init: * @klass: The PkControlClass **/ @@ -2347,7 +2347,7 @@ pk_control_class_init (PkControlClass *klass) g_type_class_add_private (klass, sizeof (PkControlPrivate)); } -/** +/* * pk_control_name_appeared_cb: **/ static void @@ -2362,7 +2362,7 @@ pk_control_name_appeared_cb (GDBusConnection *connection, g_object_notify (G_OBJECT(control), "connected"); } -/** +/* * pk_control_proxy_destroy: **/ static void @@ -2380,7 +2380,7 @@ pk_control_proxy_destroy (PkControl *control) control->priv->proxy = NULL; } -/** +/* * pk_control_name_vanished_cb: **/ static void @@ -2399,7 +2399,7 @@ pk_control_name_vanished_cb (GDBusConnection *connection, pk_control_proxy_destroy (control); } -/** +/* * pk_control_init: * @control: This class instance **/ @@ -2422,7 +2422,7 @@ pk_control_init (PkControl *control) NULL); } -/** +/* * pk_control_finalize: * @object: The object to finalize **/ diff --git a/lib/packagekit-glib2/pk-control.h b/lib/packagekit-glib2/pk-control.h index a1abe6c70..80025fcb5 100644 --- a/lib/packagekit-glib2/pk-control.h +++ b/lib/packagekit-glib2/pk-control.h @@ -53,6 +53,7 @@ G_DEFINE_AUTOPTR_CLEANUP_FUNC(PkControl, g_object_unref) /** * PkControlError: * @PK_CONTROL_ERROR_FAILED: the transaction failed for an unknown reason + * @PK_CONTROL_ERROR_CANNOT_START_DAEMON: the PackageKit daemon failed to start * * Errors that can be thrown */ diff --git a/lib/packagekit-glib2/pk-debug.c b/lib/packagekit-glib2/pk-debug.c index 6df2ffbdd..d0cb521f2 100644 --- a/lib/packagekit-glib2/pk-debug.c +++ b/lib/packagekit-glib2/pk-debug.c @@ -33,7 +33,9 @@ static gboolean _console = FALSE; /** * pk_debug_is_verbose: * - * Returns: TRUE if we have debugging enabled + * Check if verbose debugging is enabled. + * + * Returns: %TRUE if we have debugging enabled **/ gboolean pk_debug_is_verbose (void) @@ -49,7 +51,7 @@ pk_debug_is_verbose (void) } -/** +/* * pk_debug_ignore_cb: **/ static void @@ -70,7 +72,7 @@ pk_debug_ignore_cb (const gchar *log_domain, GLogLevelFlags log_level, #define PK_DEBUG_LOG_DOMAIN_LENGTH 20 -/** +/* * pk_debug_handler_cb: **/ static void @@ -128,7 +130,7 @@ out: g_mutex_unlock (&mutex); } -/** +/* * pk_debug_pre_parse_hook: */ static gboolean @@ -148,6 +150,7 @@ pk_debug_pre_parse_hook (GOptionContext *context, GOptionGroup *group, gpointer /** * pk_debug_add_log_domain: + * @log_domain: */ void pk_debug_add_log_domain (const gchar *log_domain) @@ -170,6 +173,9 @@ pk_debug_add_log_domain (const gchar *log_domain) /** * pk_debug_set_verbose: + * @verbose: %TRUE if verbose debugging should be enabled. + * + * Set if verbose debugging is enabled. */ void pk_debug_set_verbose (gboolean verbose) @@ -178,7 +184,7 @@ pk_debug_set_verbose (gboolean verbose) _console = (isatty (fileno (stdout)) == 1); } -/** +/* * pk_debug_post_parse_hook: */ static gboolean diff --git a/lib/packagekit-glib2/pk-desktop.c b/lib/packagekit-glib2/pk-desktop.c index a154321d9..840b2fce0 100644 --- a/lib/packagekit-glib2/pk-desktop.c +++ b/lib/packagekit-glib2/pk-desktop.c @@ -53,7 +53,7 @@ static gpointer pk_desktop_object = NULL; * pk_desktop_get_files_for_package: * @desktop: a valid #PkDesktop instance * @package: the package name, e.g. "gnome-power-manager" - * @error: a %GError to put the error code and message in, or %NULL + * @error: a #GError to put the error code and message in, or %NULL * * Return all desktop files owned by a package, regardless if they are shown * in the main menu or not. @@ -76,7 +76,7 @@ pk_desktop_get_files_for_package (PkDesktop *desktop, const gchar *package, GErr * pk_desktop_get_shown_for_package: * @desktop: a valid #PkDesktop instance * @package: the package name, e.g. "gnome-power-manager" - * @error: a %GError to put the error code and message in, or %NULL + * @error: a #GError to put the error code and message in, or %NULL * * Return all desktop files owned by a package that would be shown in a menu, * i.e are an application @@ -99,7 +99,7 @@ pk_desktop_get_shown_for_package (PkDesktop *desktop, const gchar *package, GErr * pk_desktop_get_package_for_file: * @desktop: a valid #PkDesktop instance * @filename: a fully qualified filename - * @error: a %GError to put the error code and message in, or %NULL + * @error: a #GError to put the error code and message in, or %NULL * * Returns the package name that owns the desktop file. Fast. * @@ -120,12 +120,13 @@ pk_desktop_get_package_for_file (PkDesktop *desktop, const gchar *filename, GErr /** * pk_desktop_open_database: * @desktop: a valid #PkDesktop instance + * @error: a #GError to put the error code and message in, or %NULL * - * Return value: %TRUE if opened correctly - * - * NOTE: This method is unused and will be removed next time the library + * This method is unused and will be removed next time the library * soname changes! * + * Return value: %TRUE if opened correctly + * * Since: 0.5.3 **/ gboolean @@ -134,7 +135,7 @@ pk_desktop_open_database (PkDesktop *desktop, GError **error) return TRUE; } -/** +/* * pk_desktop_class_init: **/ static void @@ -145,7 +146,7 @@ pk_desktop_class_init (PkDesktopClass *klass) g_type_class_add_private (klass, sizeof (PkDesktopPrivate)); } -/** +/* * pk_desktop_init: **/ static void @@ -154,7 +155,7 @@ pk_desktop_init (PkDesktop *desktop) desktop->priv = PK_DESKTOP_GET_PRIVATE (desktop); } -/** +/* * pk_desktop_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-details.c b/lib/packagekit-glib2/pk-details.c index 183f70867..2eb5d00c6 100644 --- a/lib/packagekit-glib2/pk-details.c +++ b/lib/packagekit-glib2/pk-details.c @@ -189,7 +189,7 @@ pk_details_get_size (PkDetails *details) return details->priv->size; } -/** +/* * pk_details_get_property: **/ static void @@ -226,7 +226,7 @@ pk_details_get_property (GObject *object, guint prop_id, GValue *value, GParamSp } } -/** +/* * pk_details_set_property: **/ static void @@ -268,7 +268,7 @@ pk_details_set_property (GObject *object, guint prop_id, const GValue *value, GP } } -/** +/* * pk_details_class_init: **/ static void @@ -353,7 +353,7 @@ pk_details_class_init (PkDetailsClass *klass) g_type_class_add_private (klass, sizeof (PkDetailsPrivate)); } -/** +/* * pk_details_init: **/ static void @@ -362,7 +362,7 @@ pk_details_init (PkDetails *details) details->priv = PK_DETAILS_GET_PRIVATE (details); } -/** +/* * pk_details_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-distro-upgrade.c b/lib/packagekit-glib2/pk-distro-upgrade.c index ac1a47547..dfc3d4ed5 100644 --- a/lib/packagekit-glib2/pk-distro-upgrade.c +++ b/lib/packagekit-glib2/pk-distro-upgrade.c @@ -115,7 +115,7 @@ pk_distro_upgrade_get_state (PkDistroUpgrade *distro_upgrade) } -/** +/* * pk_distro_upgrade_get_property: **/ static void @@ -140,7 +140,7 @@ pk_distro_upgrade_get_property (GObject *object, guint prop_id, GValue *value, G } } -/** +/* * pk_distro_upgrade_set_property: **/ static void @@ -167,7 +167,7 @@ pk_distro_upgrade_set_property (GObject *object, guint prop_id, const GValue *va } } -/** +/* * pk_distro_upgrade_class_init: **/ static void @@ -212,7 +212,7 @@ pk_distro_upgrade_class_init (PkDistroUpgradeClass *klass) g_type_class_add_private (klass, sizeof (PkDistroUpgradePrivate)); } -/** +/* * pk_distro_upgrade_init: **/ static void @@ -221,7 +221,7 @@ pk_distro_upgrade_init (PkDistroUpgrade *distro_upgrade) distro_upgrade->priv = PK_DISTRO_UPGRADE_GET_PRIVATE (distro_upgrade); } -/** +/* * pk_distro_upgrade_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-enum.h b/lib/packagekit-glib2/pk-enum.h index b52690f44..8b355bc6a 100644 --- a/lib/packagekit-glib2/pk-enum.h +++ b/lib/packagekit-glib2/pk-enum.h @@ -32,6 +32,8 @@ G_BEGIN_DECLS /** * PkEnumMatch: + * @value: enumerated value + * @string: string for given value * * Matching an enumerated type to a string **/ @@ -42,6 +44,41 @@ typedef struct { /** * PkRoleEnum: + * @PK_ROLE_ENUM_UNKNOWN: Unknow request + * @PK_ROLE_ENUM_CANCEL: Cancel transaction + * @PK_ROLE_ENUM_DEPENDS_ON: Get package dependencies + * @PK_ROLE_ENUM_GET_DETAILS: Get package details + * @PK_ROLE_ENUM_GET_FILES: + * @PK_ROLE_ENUM_GET_PACKAGES: Get available packages + * @PK_ROLE_ENUM_GET_REPO_LIST: Get repository list + * @PK_ROLE_ENUM_REQUIRED_BY: Get packages required by given package + * @PK_ROLE_ENUM_GET_UPDATE_DETAIL: Get update details + * @PK_ROLE_ENUM_GET_UPDATES: Get available updates + * @PK_ROLE_ENUM_INSTALL_FILES: Install package files + * @PK_ROLE_ENUM_INSTALL_PACKAGES: Install packages + * @PK_ROLE_ENUM_INSTALL_SIGNATURE: Install signature + * @PK_ROLE_ENUM_REFRESH_CACHE: Refresh cache + * @PK_ROLE_ENUM_REMOVE_PACKAGES: Remove packages + * @PK_ROLE_ENUM_REPO_ENABLE: Enable repository + * @PK_ROLE_ENUM_REPO_SET_DATA: + * @PK_ROLE_ENUM_RESOLVE: Resolve depdencies + * @PK_ROLE_ENUM_SEARCH_DETAILS: Search for details + * @PK_ROLE_ENUM_SEARCH_FILE: Search for file + * @PK_ROLE_ENUM_SEARCH_GROUP: Search for group + * @PK_ROLE_ENUM_SEARCH_NAME: Search for package name + * @PK_ROLE_ENUM_UPDATE_PACKAGES: Update packages + * @PK_ROLE_ENUM_WHAT_PROVIDES: Get what a package provides + * @PK_ROLE_ENUM_ACCEPT_EULA: Accept an EULA + * @PK_ROLE_ENUM_DOWNLOAD_PACKAGES: Download packages + * @PK_ROLE_ENUM_GET_DISTRO_UPGRADES: Get available distribution upgrades + * @PK_ROLE_ENUM_GET_CATEGORIES: Get available categories + * @PK_ROLE_ENUM_GET_OLD_TRANSACTIONS: Get old transation information + * @PK_ROLE_ENUM_REPAIR_SYSTEM: Repair system + * @PK_ROLE_ENUM_GET_DETAILS_LOCAL: Get details on local package + * @PK_ROLE_ENUM_GET_FILES_LOCAL: Get files provided by local package + * @PK_ROLE_ENUM_REPO_REMOVE: Remove repository + * @PK_ROLE_ENUM_UPGRADE_SYSTEM: Upgrade system + * @PK_ROLE_ENUM_LAST: * * What we were asked to do, this never changes for the lifetime of the * transaction. @@ -88,6 +125,44 @@ typedef enum { /** * PkStatusEnum: + * @PK_STATUS_ENUM_UNKNOWN: Unknown status + * @PK_STATUS_ENUM_WAIT: Waiting + * @PK_STATUS_ENUM_SETUP: Setting up + * @PK_STATUS_ENUM_RUNNING: Running + * @PK_STATUS_ENUM_QUERY: + * @PK_STATUS_ENUM_INFO: + * @PK_STATUS_ENUM_REMOVE: Removing + * @PK_STATUS_ENUM_REFRESH_CACHE: Refreshing cache + * @PK_STATUS_ENUM_DOWNLOAD: Downloading + * @PK_STATUS_ENUM_INSTALL: Installing + * @PK_STATUS_ENUM_UPDATE: Updating + * @PK_STATUS_ENUM_CLEANUP: Cleaning up + * @PK_STATUS_ENUM_OBSOLETE: + * @PK_STATUS_ENUM_DEP_RESOLVE: Resolving dependencies + * @PK_STATUS_ENUM_SIG_CHECK: Checking signatures + * @PK_STATUS_ENUM_TEST_COMMIT: Testing commit + * @PK_STATUS_ENUM_COMMIT: Committing + * @PK_STATUS_ENUM_REQUEST: + * @PK_STATUS_ENUM_FINISHED: Finished + * @PK_STATUS_ENUM_CANCEL: Cancelling + * @PK_STATUS_ENUM_DOWNLOAD_REPOSITORY: Downloading respository + * @PK_STATUS_ENUM_DOWNLOAD_PACKAGELIST: Donwloading package list + * @PK_STATUS_ENUM_DOWNLOAD_FILELIST: Downloading file list + * @PK_STATUS_ENUM_DOWNLOAD_CHANGELOG: Downloading changelog information + * @PK_STATUS_ENUM_DOWNLOAD_GROUP: Downloading group information + * @PK_STATUS_ENUM_DOWNLOAD_UPDATEINFO: Downloading update information + * @PK_STATUS_ENUM_REPACKAGING: Repackaging + * @PK_STATUS_ENUM_LOADING_CACHE: Loading cache + * @PK_STATUS_ENUM_SCAN_APPLICATIONS: Scanning for applications + * @PK_STATUS_ENUM_GENERATE_PACKAGE_LIST: Generating package list + * @PK_STATUS_ENUM_WAITING_FOR_LOCK: Waiting for lock + * @PK_STATUS_ENUM_WAITING_FOR_AUTH: Waiting for authentication/authorization + * @PK_STATUS_ENUM_SCAN_PROCESS_LIST: Scanning running processes + * @PK_STATUS_ENUM_CHECK_EXECUTABLE_FILES: Checking executable files + * @PK_STATUS_ENUM_CHECK_LIBRARIES: Checking libraries + * @PK_STATUS_ENUM_COPY_FILES: Copying files + * @PK_STATUS_ENUM_RUN_HOOK: Running package hook + * @PK_STATUS_ENUM_LAST: * * What status we are now; this can change for each transaction giving a * status of what sort of thing is happening @@ -149,6 +224,19 @@ typedef enum { /** * PkExitEnum: + * @PK_EXIT_ENUM_UNKNOWN: Unknown exit status + * @PK_EXIT_ENUM_SUCCESS: Backend exited successfully + * @PK_EXIT_ENUM_FAILED: Backend failed + * @PK_EXIT_ENUM_CANCELLED: Backend was cancelled + * @PK_EXIT_ENUM_KEY_REQUIRED: A repository encryption key needs installing + * @PK_EXIT_ENUM_EULA_REQUIRED: A EULA is required to be accepted + * @PK_EXIT_ENUM_KILLED: Backend was killed + * @PK_EXIT_ENUM_MEDIA_CHANGE_REQUIRED: Media change required + * @PK_EXIT_ENUM_NEED_UNTRUSTED: + * @PK_EXIT_ENUM_CANCELLED_PRIORITY: Cancelled due to higher priority task + * @PK_EXIT_ENUM_SKIP_TRANSACTION: + * @PK_EXIT_ENUM_REPAIR_REQUIRED: Package database requires repairing + * @PK_EXIT_ENUM_LAST: * * How the backend exited **/ @@ -170,6 +258,15 @@ typedef enum { /** * PkNetworkEnum: + * @PK_NETWORK_ENUM_UNKNOWN: Unknown network + * @PK_NETWORK_ENUM_OFFLINE: Offline (no network) + * @PK_NETWORK_ENUM_ONLINE: Online (network type unknown) + * @PK_NETWORK_ENUM_WIRED: Wired network + * @PK_NETWORK_ENUM_WIFI: WiFi network + * @PK_NETWORK_ENUM_MOBILE: Mobile network + * @PK_NETWORK_ENUM_LAST: + * + * Network type **/ typedef enum { PK_NETWORK_ENUM_UNKNOWN, @@ -183,6 +280,35 @@ typedef enum { /** * PkFilterEnum: + * @PK_FILTER_ENUM_UNKNOWN: Unknown filter + * @PK_FILTER_ENUM_NONE: No filter + * @PK_FILTER_ENUM_INSTALLED: Filter for installed packages + * @PK_FILTER_ENUM_NOT_INSTALLED: Filter for not installed packages + * @PK_FILTER_ENUM_DEVELOPMENT: Filter for development packages + * @PK_FILTER_ENUM_NOT_DEVELOPMENT: Filter for non-development packages + * @PK_FILTER_ENUM_GUI: Filter for GUI packages + * @PK_FILTER_ENUM_NOT_GUI: Filter for non-GUI packages + * @PK_FILTER_ENUM_FREE: Filter for free packages + * @PK_FILTER_ENUM_NOT_FREE: Filter for non-free packages + * @PK_FILTER_ENUM_VISIBLE: Filter for visible packages + * @PK_FILTER_ENUM_NOT_VISIBLE: Filter for invisible packages + * @PK_FILTER_ENUM_SUPPORTED: Filter for supported packages + * @PK_FILTER_ENUM_NOT_SUPPORTED: Filter for not supported packages + * @PK_FILTER_ENUM_BASENAME: Filter for packages that match basename + * @PK_FILTER_ENUM_NOT_BASENAME: Filter for packages that don't match basename + * @PK_FILTER_ENUM_NEWEST: Filter for newest packages + * @PK_FILTER_ENUM_NOT_NEWEST: Filter for not newest packages + * @PK_FILTER_ENUM_ARCH: Filter for packages that match architecture + * @PK_FILTER_ENUM_NOT_ARCH: Filter for packages that don't match architecture + * @PK_FILTER_ENUM_SOURCE: Filter for source packages + * @PK_FILTER_ENUM_NOT_SOURCE: Filter for non-source packages + * @PK_FILTER_ENUM_COLLECTIONS: Filter for collections + * @PK_FILTER_ENUM_NOT_COLLECTIONS: Filter for not collections + * @PK_FILTER_ENUM_APPLICATION: Filter for application packages + * @PK_FILTER_ENUM_NOT_APPLICATION: Filter for non-application packages + * @PK_FILTER_ENUM_DOWNLOADED: Filter for downloaded packages + * @PK_FILTER_ENUM_NOT_DOWNLOADED: Filter for not downloaded packages + * @PK_FILTER_ENUM_LAST: * * The filter types **/ @@ -220,6 +346,14 @@ typedef enum { /** * PkRestartEnum: + * @PK_RESTART_ENUM_UNKNOWN: Unknown restart state + * @PK_RESTART_ENUM_NONE: No restart required + * @PK_RESTART_ENUM_APPLICATION: Need to restart the application + * @PK_RESTART_ENUM_SESSION: Need to restart the session + * @PK_RESTART_ENUM_SYSTEM: Need to restart the system + * @PK_RESTART_ENUM_SECURITY_SESSION: + * @PK_RESTART_ENUM_SECURITY_SYSTEM: + * @PK_RESTART_ENUM_LAST: * * What restart we need to after a transaction, ordered by severity **/ @@ -236,6 +370,76 @@ typedef enum { /** * PkErrorEnum: + * @PK_ERROR_ENUM_UNKNOWN: + * @PK_ERROR_ENUM_OOM: Out of memory + * @PK_ERROR_ENUM_NO_NETWORK: No network access available + * @PK_ERROR_ENUM_NOT_SUPPORTED: Request not supported + * @PK_ERROR_ENUM_INTERNAL_ERROR: Undefined internal error + * @PK_ERROR_ENUM_GPG_FAILURE: GPG encryption failure + * @PK_ERROR_ENUM_PACKAGE_ID_INVALID: Invalid package ID provided + * @PK_ERROR_ENUM_PACKAGE_NOT_INSTALLED: Requested package not installed + * @PK_ERROR_ENUM_PACKAGE_NOT_FOUND: Requested package not found + * @PK_ERROR_ENUM_PACKAGE_ALREADY_INSTALLED: Requested package already installed + * @PK_ERROR_ENUM_PACKAGE_DOWNLOAD_FAILED: Failed to download package + * @PK_ERROR_ENUM_GROUP_NOT_FOUND: Requested group not gound + * @PK_ERROR_ENUM_GROUP_LIST_INVALID: Invalid group list provided + * @PK_ERROR_ENUM_DEP_RESOLUTION_FAILED: Failed to resolve dependencies + * @PK_ERROR_ENUM_FILTER_INVALID: Invalid filter provides + * @PK_ERROR_ENUM_CREATE_THREAD_FAILED: Failed to create thread + * @PK_ERROR_ENUM_TRANSACTION_ERROR: Error occurred during transaction + * @PK_ERROR_ENUM_TRANSACTION_CANCELLED: Transaction was cancelled + * @PK_ERROR_ENUM_NO_CACHE: No cache available + * @PK_ERROR_ENUM_REPO_NOT_FOUND: Requested repository not found + * @PK_ERROR_ENUM_CANNOT_REMOVE_SYSTEM_PACKAGE: Not allowed to remove system package + * @PK_ERROR_ENUM_PROCESS_KILL: Process killed + * @PK_ERROR_ENUM_FAILED_INITIALIZATION: + * @PK_ERROR_ENUM_FAILED_FINALISE: + * @PK_ERROR_ENUM_FAILED_CONFIG_PARSING: Configuration is not valid + * @PK_ERROR_ENUM_CANNOT_CANCEL: + * @PK_ERROR_ENUM_CANNOT_GET_LOCK: Cannot get lock + * @PK_ERROR_ENUM_NO_PACKAGES_TO_UPDATE: No packages to update + * @PK_ERROR_ENUM_CANNOT_WRITE_REPO_CONFIG: Cannot write repository configuration + * @PK_ERROR_ENUM_LOCAL_INSTALL_FAILED: + * @PK_ERROR_ENUM_BAD_GPG_SIGNATURE: Bad GPG signature found + * @PK_ERROR_ENUM_MISSING_GPG_SIGNATURE: Required GPG signature not found + * @PK_ERROR_ENUM_CANNOT_INSTALL_SOURCE_PACKAGE: Cannot install source package + * @PK_ERROR_ENUM_REPO_CONFIGURATION_ERROR: + * @PK_ERROR_ENUM_NO_LICENSE_AGREEMENT: + * @PK_ERROR_ENUM_FILE_CONFLICTS: File conflicts detected + * @PK_ERROR_ENUM_PACKAGE_CONFLICTS: Package conflict + * @PK_ERROR_ENUM_REPO_NOT_AVAILABLE: Repository not available + * @PK_ERROR_ENUM_INVALID_PACKAGE_FILE: + * @PK_ERROR_ENUM_PACKAGE_INSTALL_BLOCKED: Package installation blocked + * @PK_ERROR_ENUM_PACKAGE_CORRUPT: Package corruption occurred + * @PK_ERROR_ENUM_ALL_PACKAGES_ALREADY_INSTALLED: All packages already installed + * @PK_ERROR_ENUM_FILE_NOT_FOUND: Required file not found + * @PK_ERROR_ENUM_NO_MORE_MIRRORS_TO_TRY: Out of repository mirrors to try + * @PK_ERROR_ENUM_NO_DISTRO_UPGRADE_DATA: No distribution upgrade path found + * @PK_ERROR_ENUM_INCOMPATIBLE_ARCHITECTURE: Incompatible architecture found + * @PK_ERROR_ENUM_NO_SPACE_ON_DEVICE: Out of required disk space + * @PK_ERROR_ENUM_MEDIA_CHANGE_REQUIRED: Need to change media + * @PK_ERROR_ENUM_NOT_AUTHORIZED: Authorization failed + * @PK_ERROR_ENUM_UPDATE_NOT_FOUND: Update not found + * @PK_ERROR_ENUM_CANNOT_INSTALL_REPO_UNSIGNED: Installation repository missing signature + * @PK_ERROR_ENUM_CANNOT_UPDATE_REPO_UNSIGNED: Update repository missing signature + * @PK_ERROR_ENUM_CANNOT_GET_FILELIST: Cannot get file list + * @PK_ERROR_ENUM_CANNOT_GET_REQUIRES: Cannot get package requirements + * @PK_ERROR_ENUM_CANNOT_DISABLE_REPOSITORY: Cannot disable reposoitory + * @PK_ERROR_ENUM_RESTRICTED_DOWNLOAD: + * @PK_ERROR_ENUM_PACKAGE_FAILED_TO_CONFIGURE: Package failed to configure + * @PK_ERROR_ENUM_PACKAGE_FAILED_TO_BUILD: Package failed to build + * @PK_ERROR_ENUM_PACKAGE_FAILED_TO_INSTALL: Package failed to install + * @PK_ERROR_ENUM_PACKAGE_FAILED_TO_REMOVE: Package failed to remove + * @PK_ERROR_ENUM_UPDATE_FAILED_DUE_TO_RUNNING_PROCESS: + * @PK_ERROR_ENUM_PACKAGE_DATABASE_CHANGED: + * @PK_ERROR_ENUM_PROVIDE_TYPE_NOT_SUPPORTED: + * @PK_ERROR_ENUM_INSTALL_ROOT_INVALID: Installtion root not suitable + * @PK_ERROR_ENUM_CANNOT_FETCH_SOURCES: Cannot fetch sources + * @PK_ERROR_ENUM_CANCELLED_PRIORITY: Cancelled due to higher priority task + * @PK_ERROR_ENUM_UNFINISHED_TRANSACTION: Transaction unfinished + * @PK_ERROR_ENUM_LOCK_REQUIRED: Required lock not available + * @PK_ERROR_ENUM_REPO_ALREADY_SET: + * @PK_ERROR_ENUM_LAST: * * The error type **/ @@ -314,6 +518,42 @@ typedef enum { /** * PkGroupEnum: + * @PK_GROUP_ENUM_UNKNOWN: Unknown group + * @PK_GROUP_ENUM_ACCESSIBILITY: Accessibility related packages + * @PK_GROUP_ENUM_ACCESSORIES: Accessory packages + * @PK_GROUP_ENUM_ADMIN_TOOLS: Administration tools packages + * @PK_GROUP_ENUM_COMMUNICATION: Communication packages + * @PK_GROUP_ENUM_DESKTOP_GNOME: GNOME packages + * @PK_GROUP_ENUM_DESKTOP_KDE: KDE packages + * @PK_GROUP_ENUM_DESKTOP_OTHER: Other desktop packages + * @PK_GROUP_ENUM_DESKTOP_XFCE: XFCE packages + * @PK_GROUP_ENUM_EDUCATION: Education packages + * @PK_GROUP_ENUM_FONTS: Fonts + * @PK_GROUP_ENUM_GAMES: Games + * @PK_GROUP_ENUM_GRAPHICS: Graphics related packages + * @PK_GROUP_ENUM_INTERNET: Internet related packages + * @PK_GROUP_ENUM_LEGACY: Legacy packages + * @PK_GROUP_ENUM_LOCALIZATION: Localization related packages + * @PK_GROUP_ENUM_MAPS: Map related packages + * @PK_GROUP_ENUM_MULTIMEDIA: Multimedia packages + * @PK_GROUP_ENUM_NETWORK: Network related packages + * @PK_GROUP_ENUM_OFFICE: Office packages + * @PK_GROUP_ENUM_OTHER: + * @PK_GROUP_ENUM_POWER_MANAGEMENT: Power-management related packages + * @PK_GROUP_ENUM_PROGRAMMING: Programming packages + * @PK_GROUP_ENUM_PUBLISHING: Publishing related packages + * @PK_GROUP_ENUM_REPOS: + * @PK_GROUP_ENUM_SECURITY: Security packages + * @PK_GROUP_ENUM_SERVERS: Server related packages + * @PK_GROUP_ENUM_SYSTEM: System packages + * @PK_GROUP_ENUM_VIRTUALIZATION: Virtualization packages + * @PK_GROUP_ENUM_SCIENCE: Science related packages + * @PK_GROUP_ENUM_DOCUMENTATION: Documentation + * @PK_GROUP_ENUM_ELECTRONICS: Electronics package + * @PK_GROUP_ENUM_COLLECTIONS: + * @PK_GROUP_ENUM_VENDOR: Vendor defined group + * @PK_GROUP_ENUM_NEWEST: Special group for recently updated packages + * @PK_GROUP_ENUM_LAST: * * The group type **/ @@ -358,6 +598,11 @@ typedef enum { /** * PkUpdateStateEnum: + * @PK_UPDATE_STATE_ENUM_UNKNOWN: Update stability unknown + * @PK_UPDATE_STATE_ENUM_STABLE: Update is a stable release + * @PK_UPDATE_STATE_ENUM_UNSTABLE: Update is an unstable release + * @PK_UPDATE_STATE_ENUM_TESTING: Update is a testing release + * @PK_UPDATE_STATE_ENUM_LAST: * * What state the update is in **/ @@ -371,6 +616,33 @@ typedef enum { /** * PkInfoEnum: + * @PK_INFO_ENUM_UNKNOWN: Package status is unknown + * @PK_INFO_ENUM_INSTALLED: Package is installed + * @PK_INFO_ENUM_AVAILABLE: Package is available to be installed + * @PK_INFO_ENUM_LOW: + * @PK_INFO_ENUM_ENHANCEMENT: + * @PK_INFO_ENUM_NORMAL: + * @PK_INFO_ENUM_BUGFIX: + * @PK_INFO_ENUM_IMPORTANT: + * @PK_INFO_ENUM_SECURITY: + * @PK_INFO_ENUM_BLOCKED: Package is blocked + * @PK_INFO_ENUM_DOWNLOADING: Package is downloading + * @PK_INFO_ENUM_UPDATING: Package is updating + * @PK_INFO_ENUM_INSTALLING: Package is being installed + * @PK_INFO_ENUM_REMOVING: Package is being removed + * @PK_INFO_ENUM_CLEANUP: Package is running cleanup + * @PK_INFO_ENUM_OBSOLETING: + * @PK_INFO_ENUM_COLLECTION_INSTALLED: + * @PK_INFO_ENUM_COLLECTION_AVAILABLE: + * @PK_INFO_ENUM_FINISHED: + * @PK_INFO_ENUM_REINSTALLING: Package is being reinstalled + * @PK_INFO_ENUM_DOWNGRADING: Package is being downgraded + * @PK_INFO_ENUM_PREPARING: Package is preparing for installation/removal + * @PK_INFO_ENUM_DECOMPRESSING: Package is decompressing + * @PK_INFO_ENUM_UNTRUSTED: + * @PK_INFO_ENUM_TRUSTED: + * @PK_INFO_ENUM_UNAVAILABLE: Package is unavailable + * @PK_INFO_ENUM_LAST: * * The enumerated types used in Package() - these have to refer to a specific * package action, rather than a general state @@ -407,6 +679,10 @@ typedef enum { /** * PkDistroUpgradeEnum: + * @PK_DISTRO_UPGRADE_ENUM_UNKNOWN: Unknown disto upgrade state + * @PK_DISTRO_UPGRADE_ENUM_STABLE: Upgraded to stable release + * @PK_DISTRO_UPGRADE_ENUM_UNSTABLE: Upgraded to unstable release + * @PK_DISTRO_UPGRADE_ENUM_LAST: * * The distro upgrade status **/ @@ -419,6 +695,9 @@ typedef enum { /** * PkSigTypeEnum: + * @PK_SIGTYPE_ENUM_UNKNOWN: Unkwown signature type + * @PK_SIGTYPE_ENUM_GPG: GPG signature + * @PK_SIGTYPE_ENUM_LAST: * * The signature type type **/ @@ -430,6 +709,11 @@ typedef enum { /** * PkMediaTypeEnum: + * @PK_MEDIA_TYPE_ENUM_UNKNOWN: Unknown media type + * @PK_MEDIA_TYPE_ENUM_CD: Media is a CD + * @PK_MEDIA_TYPE_ENUM_DVD: Media is a DVD + * @PK_MEDIA_TYPE_ENUM_DISC: Media is a disc (not CD or DVD) + * @PK_MEDIA_TYPE_ENUM_LAST: * * The media type **/ @@ -443,6 +727,11 @@ typedef enum { /** * PkAuthorizeEnum: + * @PK_AUTHORIZE_ENUM_UNKNOWN: Unknown authorization status + * @PK_AUTHORIZE_ENUM_YES: Authorized + * @PK_AUTHORIZE_ENUM_NO: Not authorized + * @PK_AUTHORIZE_ENUM_INTERACTIVE: Interaction required for authorization + * @PK_AUTHORIZE_ENUM_LAST: * * The authorization result **/ @@ -456,6 +745,11 @@ typedef enum { /** * PkUpgradeKindEnum: + * @PK_UPGRADE_KIND_ENUM_UNKNOWN: + * @PK_UPGRADE_KIND_ENUM_MINIMAL: Perform minimal upgrade + * @PK_UPGRADE_KIND_ENUM_DEFAULT: Perform default upgrade + * @PK_UPGRADE_KIND_ENUM_COMPLETE: Perform complete upgrade + * @PK_UPGRADE_KIND_ENUM_LAST: * * The type of distribution upgrade to perform **/ @@ -469,6 +763,14 @@ typedef enum { /** * PkTransactionFlagEnum: + * @PK_TRANSACTION_FLAG_ENUM_NONE: No transaction flag + * @PK_TRANSACTION_FLAG_ENUM_ONLY_TRUSTED: Only allow trusted packages + * @PK_TRANSACTION_FLAG_ENUM_SIMULATE: Simulate transaction + * @PK_TRANSACTION_FLAG_ENUM_ONLY_DOWNLOAD: Only download packages + * @PK_TRANSACTION_FLAG_ENUM_ALLOW_REINSTALL: Allow package reinstallation + * @PK_TRANSACTION_FLAG_ENUM_JUST_REINSTALL: Only allow package reinstallation + * @PK_TRANSACTION_FLAG_ENUM_ALLOW_DOWNGRADE: Allow packages to be downgraded + * @PK_TRANSACTION_FLAG_ENUM_LAST: * * The transaction flags that alter how the transaction is handled **/ diff --git a/lib/packagekit-glib2/pk-error.c b/lib/packagekit-glib2/pk-error.c index fc2dcd8fd..e2ce22333 100644 --- a/lib/packagekit-glib2/pk-error.c +++ b/lib/packagekit-glib2/pk-error.c @@ -60,7 +60,7 @@ enum { G_DEFINE_TYPE (PkError, pk_error, PK_TYPE_SOURCE) -/** +/* * pk_error_get_property: **/ static void @@ -82,7 +82,7 @@ pk_error_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec } } -/** +/* * pk_error_set_property: **/ static void @@ -107,6 +107,11 @@ pk_error_set_property (GObject *object, guint prop_id, const GValue *value, GPar /** * pk_error_get_code: + * @error_code: a valid #PkError instance + * + * Get the error code for this error. + * + * Return value: a #PkErrorEnum * * Since: 0.5.5 **/ @@ -119,6 +124,11 @@ pk_error_get_code (PkError *error_code) /** * pk_error_get_details: + * @error_code: a valid #PkError instance + * + * Get details for this error. + * + * Return value: an string description * * Since: 0.5.5 **/ @@ -129,7 +139,7 @@ pk_error_get_details (PkError *error_code) return error_code->priv->details; } -/** +/* * pk_error_class_init: **/ static void @@ -164,7 +174,7 @@ pk_error_class_init (PkErrorClass *klass) g_type_class_add_private (klass, sizeof (PkErrorPrivate)); } -/** +/* * pk_error_init: **/ static void @@ -173,7 +183,7 @@ pk_error_init (PkError *error_code) error_code->priv = PK_ERROR_CODE_GET_PRIVATE (error_code); } -/** +/* * pk_error_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-eula-required.c b/lib/packagekit-glib2/pk-eula-required.c index 0c636b306..1ce285468 100644 --- a/lib/packagekit-glib2/pk-eula-required.c +++ b/lib/packagekit-glib2/pk-eula-required.c @@ -62,7 +62,7 @@ enum { G_DEFINE_TYPE (PkEulaRequired, pk_eula_required, PK_TYPE_SOURCE) -/** +/* * pk_eula_required_get_property: **/ static void @@ -90,7 +90,7 @@ pk_eula_required_get_property (GObject *object, guint prop_id, GValue *value, GP } } -/** +/* * pk_eula_required_set_property: **/ static void @@ -122,7 +122,7 @@ pk_eula_required_set_property (GObject *object, guint prop_id, const GValue *val } } -/** +/* * pk_eula_required_class_init: **/ static void @@ -177,7 +177,7 @@ pk_eula_required_class_init (PkEulaRequiredClass *klass) g_type_class_add_private (klass, sizeof (PkEulaRequiredPrivate)); } -/** +/* * pk_eula_required_init: **/ static void @@ -186,7 +186,7 @@ pk_eula_required_init (PkEulaRequired *eula_required) eula_required->priv = PK_EULA_REQUIRED_GET_PRIVATE (eula_required); } -/** +/* * pk_eula_required_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-files.c b/lib/packagekit-glib2/pk-files.c index d2ba01c4b..8622c441c 100644 --- a/lib/packagekit-glib2/pk-files.c +++ b/lib/packagekit-glib2/pk-files.c @@ -92,7 +92,7 @@ pk_files_get_files (PkFiles *files) return files->priv->files; } -/** +/* * pk_files_get_property: **/ static void @@ -114,7 +114,7 @@ pk_files_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec } } -/** +/* * pk_files_set_property: **/ static void @@ -138,7 +138,7 @@ pk_files_set_property (GObject *object, guint prop_id, const GValue *value, GPar } } -/** +/* * pk_files_class_init: **/ static void @@ -173,7 +173,7 @@ pk_files_class_init (PkFilesClass *klass) g_type_class_add_private (klass, sizeof (PkFilesPrivate)); } -/** +/* * pk_files_init: **/ static void @@ -184,7 +184,7 @@ pk_files_init (PkFiles *files) files->priv->files = NULL; } -/** +/* * pk_files_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-item-progress.c b/lib/packagekit-glib2/pk-item-progress.c index d710cd271..df120ba2a 100644 --- a/lib/packagekit-glib2/pk-item-progress.c +++ b/lib/packagekit-glib2/pk-item-progress.c @@ -20,7 +20,7 @@ */ /** - * SECTION:pk-item_progress + * SECTION:pk-item-progress * @short_description: ItemProgress object * * This GObject represents a item_progress from a transaction. @@ -63,6 +63,11 @@ G_DEFINE_TYPE (PkItemProgress, pk_item_progress, PK_TYPE_SOURCE) /** * pk_item_progress_get_status: + * @item_progress: a valid #PkItemProgress instance + * + * Get the status of this item. + * + * Return value: a #PkStatusEnum **/ guint pk_item_progress_get_status (PkItemProgress *item_progress) @@ -72,6 +77,11 @@ pk_item_progress_get_status (PkItemProgress *item_progress) /** * pk_item_progress_get_percentage: + * @item_progress: a valid #PkItemProgress instance + * + * Get the percentage complete of this item. + * + * Return value: a progress percentage (0-100) **/ guint pk_item_progress_get_percentage (PkItemProgress *item_progress) @@ -81,6 +91,11 @@ pk_item_progress_get_percentage (PkItemProgress *item_progress) /** * pk_item_progress_get_package_id: + * @item_progress: a valid #PkItemProgress instance + * + * Get the package ID this item is working on. + * + * Return value: a package ID **/ const gchar * pk_item_progress_get_package_id (PkItemProgress *item_progress) @@ -88,7 +103,7 @@ pk_item_progress_get_package_id (PkItemProgress *item_progress) return item_progress->priv->package_id; } -/** +/* * pk_item_progress_get_property: **/ static void @@ -113,7 +128,7 @@ pk_item_progress_get_property (GObject *object, guint prop_id, GValue *value, GP } } -/** +/* * pk_item_progress_set_property: **/ static void @@ -139,7 +154,7 @@ pk_item_progress_set_property (GObject *object, guint prop_id, const GValue *val } } -/** +/* * pk_item_progress_class_init: **/ static void @@ -184,7 +199,7 @@ pk_item_progress_class_init (PkItemProgressClass *klass) g_type_class_add_private (klass, sizeof (PkItemProgressPrivate)); } -/** +/* * pk_item_progress_init: **/ static void @@ -193,7 +208,7 @@ pk_item_progress_init (PkItemProgress *item_progress) item_progress->priv = PK_ITEM_PROGRESS_GET_PRIVATE (item_progress); } -/** +/* * pk_item_progress_finalize: **/ static void @@ -210,6 +225,8 @@ pk_item_progress_finalize (GObject *object) /** * pk_item_progress_new: * + * An object containing item inside a #PkProgress. + * * Return value: a new PkItemProgress object. * * Since: 0.8.1 diff --git a/lib/packagekit-glib2/pk-media-change-required.c b/lib/packagekit-glib2/pk-media-change-required.c index 8e01aecda..ae952a0f0 100644 --- a/lib/packagekit-glib2/pk-media-change-required.c +++ b/lib/packagekit-glib2/pk-media-change-required.c @@ -62,7 +62,7 @@ enum { G_DEFINE_TYPE (PkMediaChangeRequired, pk_media_change_required, PK_TYPE_SOURCE) -/** +/* * pk_media_change_required_get_property: **/ static void @@ -87,7 +87,7 @@ pk_media_change_required_get_property (GObject *object, guint prop_id, GValue *v } } -/** +/* * pk_media_change_required_set_property: **/ static void @@ -114,7 +114,7 @@ pk_media_change_required_set_property (GObject *object, guint prop_id, const GVa } } -/** +/* * pk_media_change_required_class_init: **/ static void @@ -159,7 +159,7 @@ pk_media_change_required_class_init (PkMediaChangeRequiredClass *klass) g_type_class_add_private (klass, sizeof (PkMediaChangeRequiredPrivate)); } -/** +/* * pk_media_change_required_init: **/ static void @@ -168,7 +168,7 @@ pk_media_change_required_init (PkMediaChangeRequired *media_change_required) media_change_required->priv = PK_MEDIA_CHANGE_REQUIRED_GET_PRIVATE (media_change_required); } -/** +/* * pk_media_change_required_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-offline-private.c b/lib/packagekit-glib2/pk-offline-private.c index 1ae6d8bdc..037032b54 100644 --- a/lib/packagekit-glib2/pk-offline-private.c +++ b/lib/packagekit-glib2/pk-offline-private.c @@ -31,7 +31,7 @@ #include "pk-offline.h" #include "pk-offline-private.h" -/** +/* * pk_offline_auth_set_action: * @action: a #PkOfflineAction, e.g. %PK_OFFLINE_ACTION_REBOOT * @error: A #GError or %NULL @@ -80,7 +80,7 @@ pk_offline_auth_set_action (PkOfflineAction action, GError **error) return TRUE; } -/** +/* * pk_offline_auth_cancel: * @error: A #GError or %NULL * @@ -126,7 +126,7 @@ pk_offline_auth_cancel (GError **error) return TRUE; } -/** +/* * pk_offline_auth_clear_results: * @error: A #GError or %NULL * @@ -162,7 +162,7 @@ pk_offline_auth_clear_results (GError **error) return TRUE; } -/** +/* * pk_offline_auth_invalidate: * @error: A #GError or %NULL * @@ -257,7 +257,7 @@ pk_offline_auth_trigger_prepared_file (PkOfflineAction action, const gchar *prep return TRUE; } -/** +/* * pk_offline_auth_trigger: * @action: a #PkOfflineAction, e.g. %PK_OFFLINE_ACTION_REBOOT * @error: A #GError or %NULL @@ -275,7 +275,7 @@ pk_offline_auth_trigger (PkOfflineAction action, GError **error) return pk_offline_auth_trigger_prepared_file (action, PK_OFFLINE_PREPARED_FILENAME, error); } -/** +/* * pk_offline_auth_trigger_upgrade: * @action: a #PkOfflineAction, e.g. %PK_OFFLINE_ACTION_REBOOT * @error: A #GError or %NULL @@ -293,7 +293,7 @@ pk_offline_auth_trigger_upgrade (PkOfflineAction action, GError **error) return pk_offline_auth_trigger_prepared_file (action, PK_OFFLINE_PREPARED_UPGRADE_FILENAME, error); } -/** +/* * pk_offline_auth_set_prepared_ids: * @package_ids: Array of package-ids * @error: A #GError or %NULL @@ -318,7 +318,7 @@ pk_offline_auth_set_prepared_ids (gchar **package_ids, GError **error) return g_key_file_save_to_file (keyfile, PK_OFFLINE_PREPARED_FILENAME, error); } -/** +/* * pk_offline_auth_set_prepared_upgrade: * @name: Distro name to upgrade to * @release_ver: Distro version to upgrade to @@ -343,7 +343,7 @@ pk_offline_auth_set_prepared_upgrade (const gchar *name, const gchar *release_ve return g_key_file_save_to_file (keyfile, PK_OFFLINE_PREPARED_UPGRADE_FILENAME, error); } -/** +/* * pk_offline_get_prepared_upgrade: * @name: (out): Return location for the distro name * @release_ver: (out): Return location for the distro version @@ -405,7 +405,7 @@ pk_offline_get_prepared_upgrade (gchar **name, gchar **release_ver, GError **err return TRUE; } -/** +/* * pk_offline_auth_set_results: * @results: A #PkResults * @error: A #GError or %NULL diff --git a/lib/packagekit-glib2/pk-offline.c b/lib/packagekit-glib2/pk-offline.c index c17c24d06..a18448e9a 100644 --- a/lib/packagekit-glib2/pk-offline.c +++ b/lib/packagekit-glib2/pk-offline.c @@ -31,9 +31,18 @@ #include "pk-offline-private.h" /** + * SECTION:pk-offline + * @short_description: Perform offline updates + * + * Functions for perform offline updates. + */ + +/** * pk_offline_error_quark: * - * Return value: The error quark. + * An error quark for #PkOfflineError. + * + * Return value: an error quark. * * Since: 0.9.6 **/ diff --git a/lib/packagekit-glib2/pk-package-id.c b/lib/packagekit-glib2/pk-package-id.c index e46edb359..9d92c2e70 100644 --- a/lib/packagekit-glib2/pk-package-id.c +++ b/lib/packagekit-glib2/pk-package-id.c @@ -116,7 +116,7 @@ pk_package_id_build (const gchar *name, const gchar *version, NULL); } -/** +/* * pk_arch_base_ix86: **/ static gboolean @@ -130,7 +130,7 @@ pk_arch_base_ix86 (const gchar *arch) return FALSE; } -/** +/* * pk_package_id_equal_fuzzy_arch_section: **/ static gboolean diff --git a/lib/packagekit-glib2/pk-package-sack-sync.c b/lib/packagekit-glib2/pk-package-sack-sync.c index aa6fd7ae4..3a2fdd888 100644 --- a/lib/packagekit-glib2/pk-package-sack-sync.c +++ b/lib/packagekit-glib2/pk-package-sack-sync.c @@ -38,7 +38,7 @@ typedef struct { gboolean ret; } PkPackageSackHelper; -/** +/* * pk_package_sack_generic_cb: **/ static void diff --git a/lib/packagekit-glib2/pk-package-sack.c b/lib/packagekit-glib2/pk-package-sack.c index 90f6470e9..262bae1ad 100644 --- a/lib/packagekit-glib2/pk-package-sack.c +++ b/lib/packagekit-glib2/pk-package-sack.c @@ -147,7 +147,7 @@ pk_package_sack_get_array (PkPackageSack *sack) /** * pk_package_sack_filter_by_info: * @sack: a valid #PkPackageSack instance - * @info: a %PkInfoEnum value to match + * @info: a #PkInfoEnum value to match * * Returns a new package sack which only matches packages that match the * specified info enum value. @@ -248,7 +248,7 @@ pk_package_sack_add_package (PkPackageSack *sack, PkPackage *package) * pk_package_sack_add_package_by_id: * @sack: a valid #PkPackageSack instance * @package_id: a package_id descriptor - * @error: a %GError to put the error code and message in, or %NULL + * @error: a #GError to put the error code and message in, or %NULL * * Adds a package reference to the sack. * @@ -277,7 +277,7 @@ pk_package_sack_add_package_by_id (PkPackageSack *sack, return TRUE; } -/** +/* * pk_package_sack_add_packages_from_line: **/ static gboolean @@ -315,7 +315,7 @@ pk_package_sack_add_packages_from_line (PkPackageSack *sack, * pk_package_sack_add_packages_from_file: * @sack: a valid #PkPackageSack instance * @file: a valid package-list file - * @error: a %GError to put the error code and message in, or %NULL + * @error: a #GError to put the error code and message in, or %NULL * * Adds packages from package-list file to a PkPackageSack. * @@ -358,7 +358,7 @@ pk_package_sack_add_packages_from_file (PkPackageSack *sack, * pk_package_sack_to_file: * @sack: a valid #PkPackageSack instance * @file: a valid package-list file - * @error: a %GError to put the error code and message in, or %NULL + * @error: a #GError to put the error code and message in, or %NULL * * Write the contents of a PkPackageSack to a package-list file. * @@ -558,7 +558,7 @@ pk_package_sack_find_by_id_name_arch (PkPackageSack *sack, const gchar *package_ return NULL; } -/** +/* * pk_package_sack_sort_compare_name_func: **/ static gint @@ -576,7 +576,7 @@ pk_package_sack_sort_compare_name_func (PkPackage **a, PkPackage **b) return g_strcmp0 (split1[PK_PACKAGE_ID_NAME], split2[PK_PACKAGE_ID_NAME]); } -/** +/* * pk_package_sack_sort_compare_package_id_func: **/ static gint @@ -589,7 +589,7 @@ pk_package_sack_sort_compare_package_id_func (PkPackage **a, PkPackage **b) return g_strcmp0 (package_id1, package_id2); } -/** +/* * pk_package_sack_sort_compare_summary_func: **/ static gint @@ -602,7 +602,7 @@ pk_package_sack_sort_compare_summary_func (PkPackage **a, PkPackage **b) return g_strcmp0 (summary1, summary2); } -/** +/* * pk_package_sack_sort_compare_info_func: **/ static gint @@ -620,7 +620,7 @@ pk_package_sack_sort_compare_info_func (PkPackage **a, PkPackage **b) } /** - * pk_package_sack_sort_package_id: + * pk_package_sack_sort: * @sack: a valid #PkPackageSack instance * @type: the type of sorting, e.g. #PK_PACKAGE_SACK_SORT_TYPE_NAME * @@ -675,7 +675,7 @@ pk_package_sack_get_total_bytes (PkPackageSack *sack) return bytes; } -/** +/* * pk_package_sack_get_package_ids: **/ static gchar ** @@ -708,7 +708,7 @@ typedef struct { /***************************************************************************************************/ -/** +/* * pk_package_sack_merge_bool_state_finish: **/ static void @@ -732,7 +732,7 @@ pk_package_sack_merge_bool_state_finish (PkPackageSackState *state, const GError g_slice_free (PkPackageSackState, state); } -/** +/* * pk_package_sack_resolve_cb: **/ static void @@ -863,7 +863,7 @@ pk_package_sack_merge_generic_finish (PkPackageSack *sack, GAsyncResult *res, GE /***************************************************************************************************/ -/** +/* * pk_package_sack_get_details_cb: **/ static void @@ -968,7 +968,7 @@ pk_package_sack_get_details_async (PkPackageSack *sack, GCancellable *cancellabl /***************************************************************************************************/ -/** +/* * pk_package_sack_get_update_detail_cb: **/ static void @@ -1104,7 +1104,7 @@ pk_package_sack_get_update_detail_async (PkPackageSack *sack, GCancellable *canc /***************************************************************************************************/ -/** +/* * pk_package_sack_class_init: **/ static void @@ -1131,7 +1131,7 @@ pk_package_sack_class_init (PkPackageSackClass *klass) g_type_class_add_private (klass, sizeof (PkPackageSackPrivate)); } -/** +/* * pk_package_sack_init: **/ static void @@ -1146,7 +1146,7 @@ pk_package_sack_init (PkPackageSack *sack) priv->client = pk_client_new (); } -/** +/* * pk_package_sack_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-package-sack.h b/lib/packagekit-glib2/pk-package-sack.h index 81f244f0f..914d16f6e 100644 --- a/lib/packagekit-glib2/pk-package-sack.h +++ b/lib/packagekit-glib2/pk-package-sack.h @@ -70,6 +70,16 @@ struct _PkPackageSackClass void (*_pk_reserved5) (void); }; +/** + * PkPackageSackSortType: + * @PK_PACKAGE_SACK_SORT_TYPE_NAME: Sort by name + * @PK_PACKAGE_SACK_SORT_TYPE_INFO: Sort by package info + * @PK_PACKAGE_SACK_SORT_TYPE_PACKAGE_ID: Sort by package ID + * @PK_PACKAGE_SACK_SORT_TYPE_SUMMARY: Sort by summary + * @PK_PACKAGE_SACK_SORT_TYPE_LAST: + * + * Type of sort to perform. + **/ typedef enum { PK_PACKAGE_SACK_SORT_TYPE_NAME, PK_PACKAGE_SACK_SORT_TYPE_INFO, diff --git a/lib/packagekit-glib2/pk-package.c b/lib/packagekit-glib2/pk-package.c index 591a3078c..709365bc5 100644 --- a/lib/packagekit-glib2/pk-package.c +++ b/lib/packagekit-glib2/pk-package.c @@ -149,7 +149,7 @@ pk_package_equal_id (PkPackage *package1, PkPackage *package2) * pk_package_set_id: * @package: a valid #PkPackage instance * @package_id: the valid package_id - * @error: a %GError to put the error code and message in, or %NULL + * @error: a #GError to put the error code and message in, or %NULL * * Sets the package object to have the given ID * @@ -205,7 +205,7 @@ out: * pk_package_parse: * @package: a valid #PkPackage instance * @data: the data describing the package - * @error: a %GError to put the error code and message in, or %NULL + * @error: a #GError to put the error code and message in, or %NULL * * Parses the data to populate the #PkPackage. * @@ -243,7 +243,7 @@ pk_package_parse (PkPackage *package, const gchar *data, GError **error) * * Gets the package object ID * - * Return value: the %PkInfoEnum + * Return value: the #PkInfoEnum * * Since: 0.5.4 **/ @@ -257,7 +257,7 @@ pk_package_get_info (PkPackage *package) /** * pk_package_set_info: * @package: a valid #PkPackage instance - * @info: the %PkInfoEnum + * @info: the #PkInfoEnum * * Sets the package info enum. * @@ -412,7 +412,7 @@ pk_package_print (PkPackage *package) package->priv->summary); } -/** +/* * pk_package_get_property: **/ static void @@ -485,7 +485,7 @@ pk_package_get_property (GObject *object, guint prop_id, GValue *value, GParamSp } } -/** +/* * pk_package_set_property: **/ static void @@ -567,7 +567,7 @@ pk_package_set_property (GObject *object, guint prop_id, const GValue *value, GP } } -/** +/* * pk_package_class_init: * @klass: The PkPackageClass **/ @@ -805,7 +805,7 @@ pk_package_class_init (PkPackageClass *klass) g_type_class_add_private (klass, sizeof (PkPackagePrivate)); } -/** +/* * pk_package_init: * @package: This class instance **/ @@ -819,7 +819,7 @@ pk_package_init (PkPackage *package) package->priv->package_id_split[PK_PACKAGE_ID_DATA] = NULL; } -/** +/* * pk_package_finalize: * @object: The object to finalize **/ diff --git a/lib/packagekit-glib2/pk-progress-bar.c b/lib/packagekit-glib2/pk-progress-bar.c index 7975fdc2c..4fa3d1150 100644 --- a/lib/packagekit-glib2/pk-progress-bar.c +++ b/lib/packagekit-glib2/pk-progress-bar.c @@ -49,7 +49,7 @@ struct PkProgressBarPrivate G_DEFINE_TYPE (PkProgressBar, pk_progress_bar, G_TYPE_OBJECT) -/** +/* * pk_progress_bar_console: **/ static void @@ -68,29 +68,37 @@ pk_progress_bar_console (PkProgressBar *self, const gchar *tmp) /** * pk_progress_bar_set_padding: + * @progress_bar: a valid #PkProgressBar instance + * @padding: + * + * Return value: **/ gboolean -pk_progress_bar_set_padding (PkProgressBar *self, guint padding) +pk_progress_bar_set_padding (PkProgressBar *progress_bar, guint padding) { - g_return_val_if_fail (PK_IS_PROGRESS_BAR (self), FALSE); + g_return_val_if_fail (PK_IS_PROGRESS_BAR (progress_bar), FALSE); g_return_val_if_fail (padding < 100, FALSE); - self->priv->padding = padding; + progress_bar->priv->padding = padding; return TRUE; } /** * pk_progress_bar_set_size: + * @progress_bar: a valid #PkProgressBar instance + * @size: + * + * Return value: **/ gboolean -pk_progress_bar_set_size (PkProgressBar *self, guint size) +pk_progress_bar_set_size (PkProgressBar *progress_bar, guint size) { - g_return_val_if_fail (PK_IS_PROGRESS_BAR (self), FALSE); + g_return_val_if_fail (PK_IS_PROGRESS_BAR (progress_bar), FALSE); g_return_val_if_fail (size < 100, FALSE); - self->priv->size = size; + progress_bar->priv->size = size; return TRUE; } -/** +/* * pk_progress_bar_draw: **/ static gboolean @@ -124,7 +132,7 @@ pk_progress_bar_draw (PkProgressBar *self, gint percentage) return TRUE; } -/** +/* * pk_progress_bar_pulse_bar: **/ static gboolean @@ -166,7 +174,7 @@ pk_progress_bar_pulse_bar (PkProgressBar *self) return TRUE; } -/** +/* * pk_progress_bar_draw_pulse_bar: **/ static void @@ -186,42 +194,46 @@ pk_progress_bar_draw_pulse_bar (PkProgressBar *self) /** * pk_progress_bar_set_percentage: + * @progress_bar: a valid #PkProgressBar instance + * @percentage: + * + * Return value: **/ gboolean -pk_progress_bar_set_percentage (PkProgressBar *self, gint percentage) +pk_progress_bar_set_percentage (PkProgressBar *progress_bar, gint percentage) { - g_return_val_if_fail (PK_IS_PROGRESS_BAR (self), FALSE); + g_return_val_if_fail (PK_IS_PROGRESS_BAR (progress_bar), FALSE); g_return_val_if_fail (percentage <= PK_PROGRESS_BAR_PERCENTAGE_INVALID, FALSE); /* never called pk_progress_bar_start() */ - if (self->priv->percentage == G_MININT) - pk_progress_bar_start (self, "FIXME: need to call pk_progress_bar_start() earlier!"); + if (progress_bar->priv->percentage == G_MININT) + pk_progress_bar_start (progress_bar, "FIXME: need to call pk_progress_bar_start() earlier!"); /* check for old percentage */ - if (percentage == self->priv->percentage) { + if (percentage == progress_bar->priv->percentage) { g_debug ("skipping as the same"); goto out; } /* save */ - self->priv->percentage = percentage; + progress_bar->priv->percentage = percentage; /* either pulse or display */ if (percentage < 0 || percentage > 100) { - pk_progress_bar_draw (self, 0); - pk_progress_bar_draw_pulse_bar (self); + pk_progress_bar_draw (progress_bar, 0); + pk_progress_bar_draw_pulse_bar (progress_bar); } else { - if (self->priv->timer_id != 0) { - g_source_remove (self->priv->timer_id); - self->priv->timer_id = 0; + if (progress_bar->priv->timer_id != 0) { + g_source_remove (progress_bar->priv->timer_id); + progress_bar->priv->timer_id = 0; } - pk_progress_bar_draw (self, percentage); + pk_progress_bar_draw (progress_bar, percentage); } out: return TRUE; } -/** +/* * pk_strpad: * @data: the input string * @length: the desired length of the output string, with padding @@ -258,42 +270,46 @@ pk_strpad (const gchar *data, guint length) /** * pk_progress_bar_start: + * @progress_bar: a valid #PkProgressBar instance + * @text: + * + * Return value: **/ gboolean -pk_progress_bar_start (PkProgressBar *self, const gchar *text) +pk_progress_bar_start (PkProgressBar *progress_bar, const gchar *text) { gchar *text_pad; GString *str; - g_return_val_if_fail (PK_IS_PROGRESS_BAR (self), FALSE); + g_return_val_if_fail (PK_IS_PROGRESS_BAR (progress_bar), FALSE); /* same as last time */ - if (self->priv->old_start_text != NULL && text != NULL) { - if (g_strcmp0 (self->priv->old_start_text, text) == 0) + if (progress_bar->priv->old_start_text != NULL && text != NULL) { + if (g_strcmp0 (progress_bar->priv->old_start_text, text) == 0) return TRUE; } - g_free (self->priv->old_start_text); - self->priv->old_start_text = g_strdup (text); + g_free (progress_bar->priv->old_start_text); + progress_bar->priv->old_start_text = g_strdup (text); /* finish old value */ str = g_string_new (""); - if (self->priv->percentage != G_MININT) { - pk_progress_bar_draw (self, 100); + if (progress_bar->priv->percentage != G_MININT) { + pk_progress_bar_draw (progress_bar, 100); g_string_append (str, "\n"); } /* make these all the same length */ - text_pad = pk_strpad (text, self->priv->padding); + text_pad = pk_strpad (text, progress_bar->priv->padding); g_string_append (str, text_pad); /* save cursor in new position */ g_string_append_printf (str, "%c7", 0x1B); - pk_progress_bar_console (self, str->str); + pk_progress_bar_console (progress_bar, str->str); /* reset */ - if (self->priv->percentage == G_MININT) - self->priv->percentage = 0; - pk_progress_bar_draw (self, 0); + if (progress_bar->priv->percentage == G_MININT) + progress_bar->priv->percentage = 0; + pk_progress_bar_draw (progress_bar, 0); g_string_free (str, TRUE); g_free (text_pad); @@ -302,29 +318,32 @@ pk_progress_bar_start (PkProgressBar *self, const gchar *text) /** * pk_progress_bar_end: + * @progress_bar: a valid #PkProgressBar instance + * + * Return value: **/ gboolean -pk_progress_bar_end (PkProgressBar *self) +pk_progress_bar_end (PkProgressBar *progress_bar) { GString *str; - g_return_val_if_fail (PK_IS_PROGRESS_BAR (self), FALSE); + g_return_val_if_fail (PK_IS_PROGRESS_BAR (progress_bar), FALSE); /* never drawn */ - if (self->priv->percentage == G_MININT) + if (progress_bar->priv->percentage == G_MININT) return FALSE; - self->priv->percentage = G_MININT; - pk_progress_bar_draw (self, 100); + progress_bar->priv->percentage = G_MININT; + pk_progress_bar_draw (progress_bar, 100); str = g_string_new (""); g_string_append_printf (str, "\n"); - pk_progress_bar_console (self, str->str); + pk_progress_bar_console (progress_bar, str->str); g_string_free (str, TRUE); return TRUE; } -/** +/* * pk_progress_bar_finalize: **/ static void @@ -342,7 +361,7 @@ pk_progress_bar_finalize (GObject *object) G_OBJECT_CLASS (pk_progress_bar_parent_class)->finalize (object); } -/** +/* * pk_progress_bar_class_init: **/ static void @@ -353,7 +372,7 @@ pk_progress_bar_class_init (PkProgressBarClass *klass) g_type_class_add_private (klass, sizeof (PkProgressBarPrivate)); } -/** +/* * pk_progress_bar_init: **/ static void diff --git a/lib/packagekit-glib2/pk-progress.c b/lib/packagekit-glib2/pk-progress.c index c219cd571..d51aa2dad 100644 --- a/lib/packagekit-glib2/pk-progress.c +++ b/lib/packagekit-glib2/pk-progress.c @@ -83,7 +83,7 @@ enum { G_DEFINE_TYPE (PkProgress, pk_progress, G_TYPE_OBJECT) -/** +/* * pk_progress_get_property: **/ static void @@ -146,6 +146,9 @@ pk_progress_get_property (GObject *object, guint prop_id, GValue *value, GParamS /** * pk_progress_set_package_id: * @progress: a valid #PkProgress instance + * @package_id: + * + * Return value: * * Since: 0.5.2 **/ @@ -176,6 +179,8 @@ pk_progress_set_package_id (PkProgress *progress, const gchar *package_id) * pk_progress_get_package_id: * @progress: a valid #PkProgress instance * + * Return value: + * * Since: 1.0.12 **/ const gchar * @@ -188,6 +193,9 @@ pk_progress_get_package_id (PkProgress *progress) /** * pk_progress_set_item_progress: * @progress: a valid #PkProgress instance + * @item_progress: + * + * Return value: * * Since: 0.8.1 **/ @@ -227,8 +235,11 @@ pk_progress_get_item_progress (PkProgress *progress) /** * pk_progress_set_transaction_id: * @progress: a valid #PkProgress instance + * @transaction_id: * * Since: 0.5.3 + * + * Return value: **/ gboolean pk_progress_set_transaction_id (PkProgress *progress, const gchar *transaction_id) @@ -263,6 +274,9 @@ pk_progress_get_transaction_id (PkProgress *progress) /** * pk_progress_set_percentage: * @progress: a valid #PkProgress instance + * @percentage: + * + * Return value: * * Since: 0.5.2 **/ @@ -286,6 +300,8 @@ pk_progress_set_percentage (PkProgress *progress, gint percentage) * pk_progress_get_percentage: * @progress: a valid #PkProgress instance * + * Return value: + * * Since: 1.0.12 **/ gint @@ -298,6 +314,9 @@ pk_progress_get_percentage (PkProgress *progress) /** * pk_progress_set_status: * @progress: a valid #PkProgress instance + * @status: + * + * Return value: * * Since: 0.5.2 **/ @@ -321,6 +340,8 @@ pk_progress_set_status (PkProgress *progress, PkStatusEnum status) * pk_progress_get_status: * @progress: a valid #PkProgress instance * + * Return value: + * * Since: 1.0.12 **/ PkStatusEnum @@ -333,6 +354,9 @@ pk_progress_get_status (PkProgress *progress) /** * pk_progress_set_role: * @progress: a valid #PkProgress instance + * @role: + * + * Return value: * * Since: 0.5.2 **/ @@ -361,6 +385,8 @@ pk_progress_set_role (PkProgress *progress, PkRoleEnum role) * pk_progress_get_role: * @progress: a valid #PkProgress instance * + * Return value: + * * Since: 1.0.12 **/ PkRoleEnum @@ -373,6 +399,9 @@ pk_progress_get_role (PkProgress *progress) /** * pk_progress_set_allow_cancel: * @progress: a valid #PkProgress instance + * @allow_cancel: + * + * Return value: * * Since: 0.5.2 **/ @@ -396,6 +425,8 @@ pk_progress_set_allow_cancel (PkProgress *progress, gboolean allow_cancel) * pk_progress_get_allow_cancel: * @progress: a valid #PkProgress instance * + * Return value: + * * Since: 1.0.12 **/ gboolean @@ -408,6 +439,9 @@ pk_progress_get_allow_cancel (PkProgress *progress) /** * pk_progress_set_caller_active: * @progress: a valid #PkProgress instance + * @caller_active: + * + * Return value: * * Since: 0.5.2 **/ @@ -431,6 +465,8 @@ pk_progress_set_caller_active (PkProgress *progress, gboolean caller_active) * pk_progress_get_caller_active: * @progress: a valid #PkProgress instance * + * Return value: + * * Since: 1.0.12 **/ gboolean @@ -443,6 +479,9 @@ pk_progress_get_caller_active (PkProgress *progress) /** * pk_progress_set_elapsed_time: * @progress: a valid #PkProgress instance + * @elapsed_time: + * + * Return value: * * Since: 0.5.2 **/ @@ -466,6 +505,8 @@ pk_progress_set_elapsed_time (PkProgress *progress, guint elapsed_time) * pk_progress_get_elapsed_time: * @progress: a valid #PkProgress instance * + * Return value: + * * Since: 1.0.12 **/ guint @@ -478,6 +519,9 @@ pk_progress_get_elapsed_time (PkProgress *progress) /** * pk_progress_set_remaining_time: * @progress: a valid #PkProgress instance + * @remaining_time: + * + * Return value: * * Since: 0.5.2 **/ @@ -501,6 +545,8 @@ pk_progress_set_remaining_time (PkProgress *progress, guint remaining_time) * pk_progress_get_remaining_time: * @progress: a valid #PkProgress instance * + * Return value: + * * Since: 1.0.12 **/ guint @@ -513,6 +559,9 @@ pk_progress_get_remaining_time (PkProgress *progress) /** * pk_progress_set_speed: * @progress: a valid #PkProgress instance + * @speed: + * + * Return value: * * Since: 0.5.2 **/ @@ -536,6 +585,8 @@ pk_progress_set_speed (PkProgress *progress, guint speed) * pk_progress_get_speed: * @progress: a valid #PkProgress instance * + * Return value: + * * Since: 1.0.12 **/ guint @@ -548,6 +599,9 @@ pk_progress_get_speed (PkProgress *progress) /** * pk_progress_set_download_size_remaining: * @progress: a valid #PkProgress instance + * @download_size_remaining: + * + * Return value: * * Since: 0.8.0 **/ @@ -571,6 +625,8 @@ pk_progress_set_download_size_remaining (PkProgress *progress, guint64 download_ * pk_progress_get_download_size_remaining: * @progress: a valid #PkProgress instance * + * Return value: + * * Since: 1.0.12 **/ guint64 @@ -583,6 +639,9 @@ pk_progress_get_download_size_remaining (PkProgress *progress) /** * pk_progress_set_transaction_flags: * @progress: a valid #PkProgress instance + * @transaction_flags: + * + * Return value: * * Since: 0.8.8 **/ @@ -606,6 +665,8 @@ pk_progress_set_transaction_flags (PkProgress *progress, guint64 transaction_fla * pk_progress_get_transaction_flags: * @progress: a valid #PkProgress instance * + * Return value: + * * Since: 1.0.12 **/ guint64 @@ -618,6 +679,9 @@ pk_progress_get_transaction_flags (PkProgress *progress) /** * pk_progress_set_uid: * @progress: a valid #PkProgress instance + * @uid: + * + * Return value: * * Since: 0.5.2 **/ @@ -641,6 +705,8 @@ pk_progress_set_uid (PkProgress *progress, guint uid) * pk_progress_get_uid: * @progress: a valid #PkProgress instance * + * Return value: + * * Since: 1.0.12 **/ guint @@ -653,6 +719,9 @@ pk_progress_get_uid (PkProgress *progress) /** * pk_progress_set_package: * @progress: a valid #PkProgress instance + * @package: + * + * Return value: * * Since: 0.5.2 **/ @@ -689,7 +758,7 @@ pk_progress_get_package (PkProgress *progress) return progress->priv->package; } -/** +/* * pk_progress_set_property: **/ static void @@ -743,7 +812,7 @@ pk_progress_set_property (GObject *object, guint prop_id, const GValue *value, G } } -/** +/* * pk_progress_class_init: **/ static void @@ -910,7 +979,7 @@ pk_progress_class_init (PkProgressClass *klass) g_type_class_add_private (klass, sizeof (PkProgressPrivate)); } -/** +/* * pk_progress_init: **/ static void @@ -919,7 +988,7 @@ pk_progress_init (PkProgress *progress) progress->priv = PK_PROGRESS_GET_PRIVATE (progress); } -/** +/* * pk_progress_finalize: **/ static void @@ -944,7 +1013,7 @@ pk_progress_finalize (GObject *object) * PkProgress is a nice GObject wrapper for PackageKit and makes writing * frontends easy. * - * Return value: A new %PkProgress instance + * Return value: A new #PkProgress instance * * Since: 0.5.2 **/ diff --git a/lib/packagekit-glib2/pk-progress.h b/lib/packagekit-glib2/pk-progress.h index 7abe83b68..765ae17b0 100644 --- a/lib/packagekit-glib2/pk-progress.h +++ b/lib/packagekit-glib2/pk-progress.h @@ -70,6 +70,27 @@ GType pk_progress_get_type (void); PkProgress *pk_progress_new (void); void pk_progress_test (gpointer user_data); +/** + * PkProgressType: + * @PK_PROGRESS_TYPE_PACKAGE_ID: package id updated + * @PK_PROGRESS_TYPE_TRANSACTION_ID: transaction ID updated + * @PK_PROGRESS_TYPE_PERCENTAGE: percentage updated + * @PK_PROGRESS_TYPE_ALLOW_CANCEL: allow cancel updated + * @PK_PROGRESS_TYPE_STATUS: status updated + * @PK_PROGRESS_TYPE_ROLE: role updated + * @PK_PROGRESS_TYPE_CALLER_ACTIVE: called active updated + * @PK_PROGRESS_TYPE_ELAPSED_TIME: elapsed time updated + * @PK_PROGRESS_TYPE_REMAINING_TIME: remaining time updated + * @PK_PROGRESS_TYPE_SPEED: speed updated + * @PK_PROGRESS_TYPE_DOWNLOAD_SIZE_REMAINING: download size remaining updated + * @PK_PROGRESS_TYPE_UID: uid updated + * @PK_PROGRESS_TYPE_PACKAGE: package updated + * @PK_PROGRESS_TYPE_ITEM_PROGRESS: item progress updated + * @PK_PROGRESS_TYPE_TRANSACTION_FLAGS: transaction flags updated + * @PK_PROGRESS_TYPE_INVALID: + * + * Flag to show which progress field has been updated. + **/ typedef enum { PK_PROGRESS_TYPE_PACKAGE_ID, PK_PROGRESS_TYPE_TRANSACTION_ID, @@ -100,7 +121,7 @@ gboolean pk_progress_set_item_progress (PkProgress *progress, PkItemProgress *item_progress); PkItemProgress *pk_progress_get_item_progress (PkProgress *progress); gboolean pk_progress_set_transaction_id (PkProgress *progress, - const gchar *package_id); + const gchar *transaction_id); const gchar *pk_progress_get_transaction_id (PkProgress *progress); gboolean pk_progress_set_percentage (PkProgress *progress, gint percentage); diff --git a/lib/packagekit-glib2/pk-repo-detail.c b/lib/packagekit-glib2/pk-repo-detail.c index d76846a61..063c2d3b1 100644 --- a/lib/packagekit-glib2/pk-repo-detail.c +++ b/lib/packagekit-glib2/pk-repo-detail.c @@ -111,7 +111,7 @@ pk_repo_detail_get_enabled (PkRepoDetail *repo_detail) return repo_detail->priv->enabled; } -/** +/* * pk_repo_detail_get_property: **/ static void @@ -136,7 +136,7 @@ pk_repo_detail_get_property (GObject *object, guint prop_id, GValue *value, GPar } } -/** +/* * pk_repo_detail_set_property: **/ static void @@ -163,7 +163,7 @@ pk_repo_detail_set_property (GObject *object, guint prop_id, const GValue *value } } -/** +/* * pk_repo_detail_class_init: **/ static void @@ -208,7 +208,7 @@ pk_repo_detail_class_init (PkRepoDetailClass *klass) g_type_class_add_private (klass, sizeof (PkRepoDetailPrivate)); } -/** +/* * pk_repo_detail_init: **/ static void @@ -217,7 +217,7 @@ pk_repo_detail_init (PkRepoDetail *repo_detail) repo_detail->priv = PK_REPO_DETAIL_GET_PRIVATE (repo_detail); } -/** +/* * pk_repo_detail_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-repo-signature-required.c b/lib/packagekit-glib2/pk-repo-signature-required.c index e404ae8e0..f57423a4d 100644 --- a/lib/packagekit-glib2/pk-repo-signature-required.c +++ b/lib/packagekit-glib2/pk-repo-signature-required.c @@ -72,7 +72,7 @@ enum { G_DEFINE_TYPE (PkRepoSignatureRequired, pk_repo_signature_required, PK_TYPE_SOURCE) -/** +/* * pk_repo_signature_required_get_property: **/ static void @@ -112,7 +112,7 @@ pk_repo_signature_required_get_property (GObject *object, guint prop_id, GValue } } -/** +/* * pk_repo_signature_required_set_property: **/ static void @@ -159,7 +159,7 @@ pk_repo_signature_required_set_property (GObject *object, guint prop_id, const G } } -/** +/* * pk_repo_signature_required_class_init: **/ static void @@ -254,7 +254,7 @@ pk_repo_signature_required_class_init (PkRepoSignatureRequiredClass *klass) g_type_class_add_private (klass, sizeof (PkRepoSignatureRequiredPrivate)); } -/** +/* * pk_repo_signature_required_init: **/ static void @@ -263,7 +263,7 @@ pk_repo_signature_required_init (PkRepoSignatureRequired *repo_signature_require repo_signature_required->priv = PK_REPO_SIGNATURE_REQUIRED_GET_PRIVATE (repo_signature_required); } -/** +/* * pk_repo_signature_required_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-require-restart.c b/lib/packagekit-glib2/pk-require-restart.c index 3a22878fa..f00e6d86c 100644 --- a/lib/packagekit-glib2/pk-require-restart.c +++ b/lib/packagekit-glib2/pk-require-restart.c @@ -60,7 +60,7 @@ enum { G_DEFINE_TYPE (PkRequireRestart, pk_require_restart, PK_TYPE_SOURCE) -/** +/* * pk_require_restart_get_property: **/ static void @@ -82,7 +82,7 @@ pk_require_restart_get_property (GObject *object, guint prop_id, GValue *value, } } -/** +/* * pk_require_restart_set_property: **/ static void @@ -105,7 +105,7 @@ pk_require_restart_set_property (GObject *object, guint prop_id, const GValue *v } } -/** +/* * pk_require_restart_class_init: **/ static void @@ -140,7 +140,7 @@ pk_require_restart_class_init (PkRequireRestartClass *klass) g_type_class_add_private (klass, sizeof (PkRequireRestartPrivate)); } -/** +/* * pk_require_restart_init: **/ static void @@ -149,7 +149,7 @@ pk_require_restart_init (PkRequireRestart *require_restart) require_restart->priv = PK_REQUIRE_RESTART_GET_PRIVATE (require_restart); } -/** +/* * pk_require_restart_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-results.c b/lib/packagekit-glib2/pk-results.c index 1b8bf73ef..094a87051 100644 --- a/lib/packagekit-glib2/pk-results.c +++ b/lib/packagekit-glib2/pk-results.c @@ -79,7 +79,7 @@ enum { G_DEFINE_TYPE (PkResults, pk_results, G_TYPE_OBJECT) -/** +/* * pk_results_get_property: **/ static void @@ -107,7 +107,7 @@ pk_results_get_property (GObject *object, guint prop_id, GValue *value, GParamSp } } -/** +/* * pk_results_set_property: **/ static void @@ -552,7 +552,6 @@ pk_results_get_error_code (PkResults *results) * * Since: 0.5.2 **/ - GPtrArray * pk_results_get_package_array (PkResults *results) { @@ -804,7 +803,7 @@ pk_results_get_repo_detail_array (PkResults *results) return g_ptr_array_ref (results->priv->repo_detail_array); } -/** +/* * pk_results_class_init: **/ static void @@ -860,7 +859,7 @@ pk_results_class_init (PkResultsClass *klass) g_object_class_install_property (object_class, PROP_PROGRESS, pspec); } -/** +/* * pk_results_init: **/ static void @@ -886,7 +885,7 @@ pk_results_init (PkResults *results) results->priv->repo_detail_array = g_ptr_array_new_with_free_func ((GDestroyNotify) g_object_unref); } -/** +/* * pk_results_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-source.c b/lib/packagekit-glib2/pk-source.c index c11f4cccc..a1f6100a4 100644 --- a/lib/packagekit-glib2/pk-source.c +++ b/lib/packagekit-glib2/pk-source.c @@ -59,7 +59,7 @@ enum { G_DEFINE_TYPE (PkSource, pk_source, G_TYPE_OBJECT) -/** +/* * pk_source_get_property: **/ static void @@ -81,7 +81,7 @@ pk_source_get_property (GObject *object, guint prop_id, GValue *value, GParamSpe } } -/** +/* * pk_source_set_property: **/ static void @@ -104,7 +104,7 @@ pk_source_set_property (GObject *object, guint prop_id, const GValue *value, GPa } } -/** +/* * pk_source_class_init: **/ static void @@ -139,7 +139,7 @@ pk_source_class_init (PkSourceClass *klass) g_type_class_add_private (klass, sizeof (PkSourcePrivate)); } -/** +/* * pk_source_init: **/ static void @@ -148,7 +148,7 @@ pk_source_init (PkSource *source) source->priv = PK_SOURCE_GET_PRIVATE (source); } -/** +/* * pk_source_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-task-sync.c b/lib/packagekit-glib2/pk-task-sync.c index a6a8c8570..e748c653d 100644 --- a/lib/packagekit-glib2/pk-task-sync.c +++ b/lib/packagekit-glib2/pk-task-sync.c @@ -39,7 +39,7 @@ typedef struct { PkResults *results; } PkTaskHelper; -/** +/* * pk_task_generic_finish_sync: **/ static void @@ -67,13 +67,13 @@ pk_task_generic_finish_sync (PkTask *task, GAsyncResult *res, PkTaskHelper *help * @error: the #GError to store any failure, or %NULL * * Remove a package (optionally with dependancies) from the system. - * If %allow_deps is set to %FALSE, and other packages would have to be removed, + * If @allow_deps is set to %FALSE, and other packages would have to be removed, * then the transaction would fail. * * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -126,7 +126,7 @@ pk_task_remove_packages_sync (PkTask *task, gchar **package_ids, gboolean allow_ * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -179,7 +179,7 @@ pk_task_install_packages_sync (PkTask *task, gchar **package_ids, GCancellable * * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -233,7 +233,7 @@ pk_task_update_packages_sync (PkTask *task, gchar **package_ids, GCancellable *c * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.5.3 **/ @@ -286,7 +286,7 @@ pk_task_install_files_sync (PkTask *task, gchar **files, GCancellable *cancellab * * Since: 0.6.5 * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error **/ PkResults * pk_task_resolve_sync (PkTask *task, PkBitfield filters, gchar **packages, GCancellable *cancellable, @@ -338,7 +338,7 @@ pk_task_resolve_sync (PkTask *task, PkBitfield filters, gchar **packages, GCance * * Since: 0.6.5 * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error **/ PkResults * pk_task_search_names_sync (PkTask *task, PkBitfield filters, gchar **values, GCancellable *cancellable, @@ -390,7 +390,7 @@ pk_task_search_names_sync (PkTask *task, PkBitfield filters, gchar **values, GCa * * Since: 0.6.5 * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error **/ PkResults * pk_task_search_details_sync (PkTask *task, PkBitfield filters, gchar **values, GCancellable *cancellable, @@ -440,7 +440,7 @@ pk_task_search_details_sync (PkTask *task, PkBitfield filters, gchar **values, G * * Searches the group lists. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.6.5 **/ @@ -492,7 +492,7 @@ pk_task_search_groups_sync (PkTask *task, PkBitfield filters, gchar **values, GC * * Searches for specific files. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.6.5 **/ @@ -543,7 +543,7 @@ pk_task_search_files_sync (PkTask *task, PkBitfield filters, gchar **values, GCa * * Gets details about packages. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.6.5 **/ @@ -594,7 +594,7 @@ pk_task_get_details_sync (PkTask *task, gchar **package_ids, GCancellable *cance * * Gets details about updates. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.6.5 **/ @@ -646,7 +646,7 @@ pk_task_get_update_detail_sync (PkTask *task, gchar **package_ids, GCancellable * * Downloads packages * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.6.5 **/ @@ -697,7 +697,7 @@ pk_task_download_packages_sync (PkTask *task, gchar **package_ids, const gchar * * * Gets the update lists. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.6.5 **/ @@ -750,7 +750,7 @@ pk_task_get_updates_sync (PkTask *task, PkBitfield filters, GCancellable *cancel * * Get the list of dependent packages. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.6.5 **/ @@ -801,7 +801,7 @@ pk_task_depends_on_sync (PkTask *task, PkBitfield filters, gchar **package_ids, * * Gets the list of packages. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.6.5 **/ @@ -854,7 +854,7 @@ pk_task_get_packages_sync (PkTask *task, PkBitfield filters, GCancellable *cance * * Get the packages this package requires. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.6.5 **/ @@ -906,7 +906,7 @@ pk_task_required_by_sync (PkTask *task, PkBitfield filters, gchar **package_ids, * * Find the package that provides some resource. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.6.5 **/ @@ -958,7 +958,7 @@ pk_task_what_provides_sync (PkTask *task, PkBitfield filters, * * Get the files in a package. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.6.5 **/ @@ -1008,7 +1008,7 @@ pk_task_get_files_sync (PkTask *task, gchar **package_ids, GCancellable *cancell * * Get the categories available. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.6.5 **/ @@ -1059,7 +1059,7 @@ pk_task_get_categories_sync (PkTask *task, GCancellable *cancellable, * * Refresh the package cache. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.6.5 **/ @@ -1110,7 +1110,7 @@ pk_task_refresh_cache_sync (PkTask *task, gboolean force, GCancellable *cancella * * Get the list of available repositories. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.6.5 **/ @@ -1162,7 +1162,7 @@ pk_task_get_repo_list_sync (PkTask *task, PkBitfield filters, GCancellable *canc * * Enable or disable a specific repo. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.6.5 **/ @@ -1218,7 +1218,7 @@ pk_task_repo_enable_sync (PkTask *task, const gchar *repo_id, gboolean enabled, * * The backend will decide what is best to do. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 1.0.12 **/ @@ -1274,7 +1274,7 @@ pk_task_upgrade_system_sync (PkTask *task, * Warning: this function is synchronous, and may block. Do not use it in GUI * applications. * - * Return value: (transfer full): a %PkResults object, or NULL for error + * Return value: (transfer full): a #PkResults object, or %NULL for error * * Since: 0.7.2 **/ diff --git a/lib/packagekit-glib2/pk-task-text.c b/lib/packagekit-glib2/pk-task-text.c index 4509eff5d..e45ffe5f3 100644 --- a/lib/packagekit-glib2/pk-task-text.c +++ b/lib/packagekit-glib2/pk-task-text.c @@ -47,7 +47,7 @@ struct _PkTaskTextPrivate G_DEFINE_TYPE (PkTaskText, pk_task_text, PK_TYPE_TASK) -/** +/* * pk_task_text_untrusted_question: **/ static void @@ -73,7 +73,7 @@ pk_task_text_untrusted_question (PkTask *task, guint request, PkResults *results } } -/** +/* * pk_task_text_key_question: **/ static void @@ -163,7 +163,7 @@ pk_task_text_key_question (PkTask *task, guint request, PkResults *results) g_ptr_array_unref (array); } -/** +/* * pk_task_text_eula_question: **/ static void @@ -229,7 +229,7 @@ pk_task_text_eula_question (PkTask *task, guint request, PkResults *results) g_ptr_array_unref (array); } -/** +/* * pk_task_text_media_change_question: **/ static void @@ -288,7 +288,7 @@ pk_task_text_media_change_question (PkTask *task, guint request, PkResults *resu g_ptr_array_unref (array); } -/** +/* * pk_task_text_simulate_question_type_to_string: **/ static const gchar * @@ -348,7 +348,7 @@ package_sort_func (gconstpointer a, gconstpointer b) return g_strcmp0 (split1[PK_PACKAGE_ID_NAME], split2[PK_PACKAGE_ID_NAME]); } -/** +/* * pk_task_text_simulate_question: **/ static void @@ -442,7 +442,7 @@ pk_task_text_simulate_question (PkTask *task, guint request, PkResults *results) g_ptr_array_unref (array); } -/** +/* * pk_task_text_class_init: **/ static void @@ -461,7 +461,7 @@ pk_task_text_class_init (PkTaskTextClass *klass) g_type_class_add_private (klass, sizeof (PkTaskTextPrivate)); } -/** +/* * pk_task_text_init: * @task_text: This class instance **/ @@ -472,7 +472,7 @@ pk_task_text_init (PkTaskText *task) task->priv->user_data = NULL; } -/** +/* * pk_task_text_finalize: * @object: The object to finalize **/ diff --git a/lib/packagekit-glib2/pk-task-text.h b/lib/packagekit-glib2/pk-task-text.h index 5885aa250..fbee92a06 100644 --- a/lib/packagekit-glib2/pk-task-text.h +++ b/lib/packagekit-glib2/pk-task-text.h @@ -49,7 +49,6 @@ struct _PkTaskTextClass PkTaskClass parent_class; }; -GQuark pk_task_text_error_quark (void); GType pk_task_text_get_type (void); PkTaskText *pk_task_text_new (void); void pk_task_text_test (gpointer user_data); diff --git a/lib/packagekit-glib2/pk-task-wrapper.c b/lib/packagekit-glib2/pk-task-wrapper.c index 7c4eaba1b..44587527c 100644 --- a/lib/packagekit-glib2/pk-task-wrapper.c +++ b/lib/packagekit-glib2/pk-task-wrapper.c @@ -43,7 +43,7 @@ struct _PkTaskWrapperPrivate G_DEFINE_TYPE (PkTaskWrapper, pk_task_wrapper, PK_TYPE_TASK) -/** +/* * pk_task_wrapper_untrusted_question: **/ static void @@ -60,7 +60,7 @@ pk_task_wrapper_untrusted_question (PkTask *task, guint request, PkResults *resu pk_task_user_accepted (task, request); } -/** +/* * pk_task_wrapper_key_question: **/ static void @@ -75,7 +75,7 @@ pk_task_wrapper_key_question (PkTask *task, guint request, PkResults *results) pk_task_user_accepted (task, request); } -/** +/* * pk_task_wrapper_eula_question: **/ static void @@ -90,7 +90,7 @@ pk_task_wrapper_eula_question (PkTask *task, guint request, PkResults *results) pk_task_user_accepted (task, request); } -/** +/* * pk_task_wrapper_media_change_question: **/ static void @@ -105,7 +105,7 @@ pk_task_wrapper_media_change_question (PkTask *task, guint request, PkResults *r pk_task_user_accepted (task, request); } -/** +/* * pk_task_wrapper_simulate_question: **/ static void @@ -139,7 +139,7 @@ pk_task_wrapper_simulate_question (PkTask *task, guint request, PkResults *resul pk_task_user_accepted (task, request); } -/** +/* * pk_task_wrapper_class_init: **/ static void @@ -158,7 +158,7 @@ pk_task_wrapper_class_init (PkTaskWrapperClass *klass) g_type_class_add_private (klass, sizeof (PkTaskWrapperPrivate)); } -/** +/* * pk_task_wrapper_init: * @task_wrapper: This class instance **/ @@ -169,7 +169,7 @@ pk_task_wrapper_init (PkTaskWrapper *task) task->priv->user_data = NULL; } -/** +/* * pk_task_wrapper_finalize: * @object: The object to finalize **/ diff --git a/lib/packagekit-glib2/pk-task-wrapper.h b/lib/packagekit-glib2/pk-task-wrapper.h index 022dffb17..331761f66 100644 --- a/lib/packagekit-glib2/pk-task-wrapper.h +++ b/lib/packagekit-glib2/pk-task-wrapper.h @@ -49,7 +49,6 @@ struct _PkTaskWrapperClass PkTaskClass parent_class; }; -GQuark pk_task_wrapper_error_quark (void); GType pk_task_wrapper_get_type (void); PkTaskWrapper *pk_task_wrapper_new (void); diff --git a/lib/packagekit-glib2/pk-task.c b/lib/packagekit-glib2/pk-task.c index 268bc5961..49c43e64a 100644 --- a/lib/packagekit-glib2/pk-task.c +++ b/lib/packagekit-glib2/pk-task.c @@ -108,7 +108,7 @@ G_DEFINE_TYPE (PkTask, pk_task, PK_TYPE_CLIENT) static void pk_task_ready_cb (GObject *source_object, GAsyncResult *res, PkTaskState *state); -/** +/* * pk_task_generate_request_id: **/ static guint @@ -118,7 +118,7 @@ pk_task_generate_request_id (void) return ++id; } -/** +/* * pk_task_find_by_request: **/ static PkTaskState * @@ -140,7 +140,7 @@ pk_task_find_by_request (PkTask *task, guint request) return NULL; } -/** +/* * pk_task_generic_state_finish: **/ static void @@ -184,7 +184,7 @@ pk_task_generic_state_finish (PkTaskState *state, const GError *error) g_slice_free (PkTaskState, state); } -/** +/* * pk_task_do_async_action: **/ static void @@ -318,7 +318,7 @@ pk_task_do_async_action (PkTaskState *state) } } -/** +/* * pk_task_package_filter_cb: **/ static gboolean @@ -337,7 +337,7 @@ pk_task_package_filter_cb (PkPackage *package, gpointer user_data) static void pk_task_do_async_simulate_action (PkTaskState *state); -/** +/* * pk_task_simulate_ready_cb: **/ static void @@ -421,7 +421,7 @@ pk_task_simulate_ready_cb (GObject *source_object, GAsyncResult *res, PkTaskStat klass->simulate_question (state->task, state->request, state->results); } -/** +/* * pk_task_do_async_simulate_action: **/ static void @@ -507,7 +507,7 @@ pk_task_do_async_simulate_action (PkTaskState *state) } } -/** +/* * pk_task_install_signatures_ready_cb: **/ static void @@ -552,7 +552,7 @@ pk_task_install_signatures_ready_cb (GObject *source_object, GAsyncResult *res, pk_task_do_async_action (state); } -/** +/* * pk_task_install_signatures: **/ static void @@ -599,7 +599,7 @@ pk_task_install_signatures (PkTaskState *state) (GAsyncReadyCallback) pk_task_install_signatures_ready_cb, state); } -/** +/* * pk_task_accept_eulas_ready_cb: **/ static void @@ -644,7 +644,7 @@ pk_task_accept_eulas_ready_cb (GObject *source_object, GAsyncResult *res, PkTask pk_task_do_async_action (state); } -/** +/* * pk_task_accept_eulas: **/ static void @@ -687,7 +687,7 @@ pk_task_accept_eulas (PkTaskState *state) (GAsyncReadyCallback) pk_task_accept_eulas_ready_cb, state); } -/** +/* * pk_task_repair_ready_cb: **/ static void @@ -733,7 +733,7 @@ pk_task_repair_ready_cb (GObject *source_object, GAsyncResult *res, PkTaskState pk_task_do_async_action (state); } -/** +/* * pk_task_user_accepted_idle_cb: **/ static gboolean @@ -773,6 +773,10 @@ pk_task_user_accepted_idle_cb (PkTaskState *state) /** * pk_task_user_accepted: + * @task: + * @request: + * + * Return value: * * Since: 0.5.2 **/ @@ -796,7 +800,7 @@ pk_task_user_accepted (PkTask *task, guint request) return TRUE; } -/** +/* * pk_task_user_declined_idle_cb: **/ static gboolean @@ -824,6 +828,10 @@ pk_task_user_declined_idle_cb (PkTaskState *state) /** * pk_task_user_declined: + * @task: + * @request: + * + * Return value: * * Since: 0.5.2 **/ @@ -847,7 +855,7 @@ pk_task_user_declined (PkTask *task, guint request) return TRUE; } -/** +/* * pk_task_retry_cancelled_transaction_cb: **/ static gboolean @@ -859,7 +867,7 @@ pk_task_retry_cancelled_transaction_cb (gpointer user_data) return FALSE; } -/** +/* * pk_task_ready_cb: **/ static void @@ -1221,7 +1229,7 @@ pk_task_upgrade_system_async (PkTask *task, * @user_data: the data to pass to @callback_ready * * Remove a package (optionally with dependancies) from the system. - * If %allow_deps is set to %FALSE, and other packages would have to be removed, + * If @allow_deps is set to %FALSE, and other packages would have to be removed, * then the transaction would fail. * * Since: 0.5.2 @@ -2043,7 +2051,7 @@ pk_task_get_files_async (PkTask *task, gchar **package_ids, GCancellable *cancel * @cancellable: a #GCancellable or %NULL * @progress_callback: (scope notified): the function to run when the progress changes * @progress_user_data: data to pass to @progress_callback - * @callback_ready (scope async): the function to run on completion + * @callback_ready: (scope async): the function to run on completion * @user_data: the data to pass to @callback * * Get the categories available. @@ -2488,7 +2496,7 @@ pk_task_get_allow_reinstall (PkTask *task) return task->priv->allow_reinstall; } -/** +/* * pk_task_get_property: **/ static void @@ -2519,7 +2527,7 @@ pk_task_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec } } -/** +/* * pk_task_set_property: **/ static void @@ -2550,7 +2558,7 @@ pk_task_set_property (GObject *object, guint prop_id, const GValue *value, GPara } } -/** +/* * pk_task_class_init: **/ static void @@ -2615,7 +2623,7 @@ pk_task_class_init (PkTaskClass *klass) g_type_class_add_private (klass, sizeof (PkTaskPrivate)); } -/** +/* * pk_task_init: **/ static void @@ -2628,7 +2636,7 @@ pk_task_init (PkTask *task) task->priv->allow_downgrade = FALSE; } -/** +/* * pk_task_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-test-daemon.c b/lib/packagekit-glib2/pk-test-daemon.c index 229841323..242f6c11a 100644 --- a/lib/packagekit-glib2/pk-test-daemon.c +++ b/lib/packagekit-glib2/pk-test-daemon.c @@ -57,7 +57,7 @@ _g_test_hang_check_cb (gpointer user_data) return FALSE; } -/** +/* * _g_test_loop_run_with_timeout: **/ static void @@ -78,7 +78,7 @@ _g_test_hang_wait_cb (gpointer user_data) return FALSE; } -/** +/* * _g_test_loop_wait: **/ static void @@ -91,7 +91,7 @@ _g_test_loop_wait (guint timeout_ms) } #endif -/** +/* * _g_test_loop_quit: **/ static void @@ -181,7 +181,7 @@ pk_test_offline_func (void) g_assert (!g_file_test (PK_OFFLINE_RESULTS_FILENAME, G_FILE_TEST_EXISTS)); } -/** +/* * pk_test_client_helper_output_cb: **/ static gboolean @@ -1000,7 +1000,7 @@ pk_test_package_sack_update_detail_cb (GObject *object, GAsyncResult *res, gpoin _g_test_loop_quit (); } -/** +/* * pk_test_package_sack_filter_cb: **/ static gboolean diff --git a/lib/packagekit-glib2/pk-transaction-list.c b/lib/packagekit-glib2/pk-transaction-list.c index cccf40d86..fc4489ba9 100644 --- a/lib/packagekit-glib2/pk-transaction-list.c +++ b/lib/packagekit-glib2/pk-transaction-list.c @@ -62,7 +62,7 @@ static guint signals [SIGNAL_LAST] = { 0 }; G_DEFINE_TYPE (PkTransactionList, pk_transaction_list, G_TYPE_OBJECT) -/** +/* * pk_transaction_list_process_transaction_list: **/ static void @@ -125,7 +125,7 @@ pk_transaction_list_process_transaction_list (PkTransactionList *tlist, gchar ** } } -/** +/* * pk_transaction_list_get_transaction_list_cb: **/ static void @@ -145,7 +145,7 @@ pk_transaction_list_get_transaction_list_cb (PkControl *control, GAsyncResult *r pk_transaction_list_process_transaction_list (tlist, transaction_ids); } -/** +/* * pk_transaction_list_get_transaction_list: **/ static void @@ -156,7 +156,7 @@ pk_transaction_list_get_transaction_list (PkTransactionList *tlist) (GAsyncReadyCallback) pk_transaction_list_get_transaction_list_cb, tlist); } -/** +/* * pk_transaction_list_task_list_changed_cb: **/ static void @@ -166,7 +166,7 @@ pk_transaction_list_task_list_changed_cb (PkControl *control, gchar **transactio pk_transaction_list_process_transaction_list (tlist, transaction_ids); } -/** +/* * pk_transaction_list_notify_connected_cb: **/ static void @@ -195,7 +195,7 @@ pk_transaction_list_get_ids (PkTransactionList *tlist) return pk_ptr_array_to_strv (tlist->priv->transaction_ids); } -/** +/* * pk_transaction_list_class_init: **/ static void @@ -236,7 +236,7 @@ pk_transaction_list_class_init (PkTransactionListClass *klass) g_type_class_add_private (klass, sizeof (PkTransactionListPrivate)); } -/** +/* * pk_transaction_list_init: **/ static void @@ -259,7 +259,7 @@ pk_transaction_list_init (PkTransactionList *tlist) pk_transaction_list_get_transaction_list (tlist); } -/** +/* * pk_transaction_list_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-transaction-past.c b/lib/packagekit-glib2/pk-transaction-past.c index 114924b75..82413bbb7 100644 --- a/lib/packagekit-glib2/pk-transaction-past.c +++ b/lib/packagekit-glib2/pk-transaction-past.c @@ -254,7 +254,7 @@ pk_transaction_past_get_cmdline (PkTransactionPast *past) return past->priv->cmdline; } -/** +/* * pk_transaction_past_get_property: **/ static void @@ -294,7 +294,7 @@ pk_transaction_past_get_property (GObject *object, guint prop_id, GValue *value, } } -/** +/* * pk_transaction_past_set_property: **/ static void @@ -338,7 +338,7 @@ pk_transaction_past_set_property (GObject *object, guint prop_id, const GValue * } } -/** +/* * pk_transaction_past_class_init: **/ static void @@ -433,7 +433,7 @@ pk_transaction_past_class_init (PkTransactionPastClass *klass) g_type_class_add_private (klass, sizeof (PkTransactionPastPrivate)); } -/** +/* * pk_transaction_past_init: **/ static void @@ -442,7 +442,7 @@ pk_transaction_past_init (PkTransactionPast *transaction_past) transaction_past->priv = PK_TRANSACTION_PAST_GET_PRIVATE (transaction_past); } -/** +/* * pk_transaction_past_finalize: **/ static void diff --git a/lib/packagekit-glib2/pk-update-detail.c b/lib/packagekit-glib2/pk-update-detail.c index 50b6c2c62..7039fe7d0 100644 --- a/lib/packagekit-glib2/pk-update-detail.c +++ b/lib/packagekit-glib2/pk-update-detail.c @@ -282,7 +282,7 @@ pk_update_detail_get_updated (PkUpdateDetail *update_detail) return update_detail->priv->updated; } -/** +/* * pk_update_detail_get_property: **/ static void @@ -334,7 +334,7 @@ pk_update_detail_get_property (GObject *object, guint prop_id, GValue *value, GP } } -/** +/* * pk_update_detail_set_property: **/ static void @@ -396,7 +396,7 @@ pk_update_detail_set_property (GObject *object, guint prop_id, const GValue *val } } -/** +/* * pk_update_detail_class_init: **/ static void @@ -531,7 +531,7 @@ pk_update_detail_class_init (PkUpdateDetailClass *klass) g_type_class_add_private (klass, sizeof (PkUpdateDetailPrivate)); } -/** +/* * pk_update_detail_init: **/ static void @@ -540,7 +540,7 @@ pk_update_detail_init (PkUpdateDetail *update_detail) update_detail->priv = PK_UPDATE_DETAIL_GET_PRIVATE (update_detail); } -/** +/* * pk_update_detail_finalize: **/ static void @@ -566,7 +566,7 @@ pk_update_detail_finalize (GObject *object) /** * pk_update_detail_new: * - * Return value: a new PkUpdateDetail object. + * Return value: a new #PkUpdateDetail object. * * Since: 0.5.4 **/ |