[gnome-software/wip/hughsie/GsPluginEvent: 1/3] trivial: Fix up a few gtk-doc mistakes

[Richard Hughes <rhughes src gnome org>]

commit deed15c264ce46f73aa3f9165f534b3be18cd679
Author: Richard Hughes <richard hughsie com>
Date:   Wed Sep 7 11:07:59 2016 +0100

    trivial: Fix up a few gtk-doc mistakes

 doc/api/gnome-software-docs.xml |    1 +
 src/gs-auth.c                   |    3 +--
 src/gs-plugin-vfuncs.h          |   18 +++++++++---------
 src/gs-utils.c                  |    2 +-
 4 files changed, 12 insertions(+), 12 deletions(-)
---
diff --git a/doc/api/gnome-software-docs.xml b/doc/api/gnome-software-docs.xml
index f2c7517..ed3a8ae 100644
--- a/doc/api/gnome-software-docs.xml
+++ b/doc/api/gnome-software-docs.xml
@@ -623,6 +623,7 @@ gs_plugin_adopt_app (GsPlugin *plugin, GsApp *app)
     <title>GNOME Software Plugin API</title>
     <xi:include href="xml/gs-app-list.xml"/>
     <xi:include href="xml/gs-app.xml"/>
+    <xi:include href="xml/gs-category.xml"/>
     <xi:include href="xml/gs-auth.xml"/>
     <xi:include href="xml/gs-os-release.xml"/>
     <xi:include href="xml/gs-plugin.xml"/>
diff --git a/src/gs-auth.c b/src/gs-auth.c
index 87c4944..e780a2a 100644
--- a/src/gs-auth.c
+++ b/src/gs-auth.c
@@ -68,8 +68,7 @@ G_DEFINE_TYPE (GsAuth, gs_auth, G_TYPE_OBJECT)
  * gs_auth_get_provider_id:
  * @auth: a #GsAuth
  *
- * Gets the authentication service name. This must match the string in
- * gs_app_get_auth_provider() to be used.
+ * Gets the authentication service ID.
  *
  * Returns: the string to use for searching, e.g. "UbuntuOne"
  */
diff --git a/src/gs-plugin-vfuncs.h b/src/gs-plugin-vfuncs.h
index 69fb5fe..525a2ae 100644
--- a/src/gs-plugin-vfuncs.h
+++ b/src/gs-plugin-vfuncs.h
@@ -155,7 +155,7 @@ gboolean     gs_plugin_add_search_what_provides     (GsPlugin       *plugin,
  * lock held.
  *
  * All functions can block, but should sent progress notifications, e.g. using
- * gs_plugin_progress_update() if they will take more than tens of milliseconds
+ * gs_app_set_progress() if they will take more than tens of milliseconds
  * to complete.
  *
  * This function will also not be called if gs_plugin_initialize() self-disabled.
@@ -506,10 +506,10 @@ gboolean   gs_plugin_update_cancel                (GsPlugin       *plugin,
  * Install the application.
  *
  * Plugins are expected to send progress notifications to the UI using
- * gs_plugin_progress_update() using the passed in @app.
+ * gs_app_set_progress() using the passed in @app.
  *
  * All functions can block, but should sent progress notifications, e.g. using
- * gs_plugin_progress_update() if they will take more than tens of milliseconds
+ * gs_app_set_progress() if they will take more than tens of milliseconds
  * to complete.
  *
  * On failure the error message returned will usually only be shown on the
@@ -536,10 +536,10 @@ gboolean   gs_plugin_app_install                  (GsPlugin       *plugin,
  * Remove the application.
  *
  * Plugins are expected to send progress notifications to the UI using
- * gs_plugin_progress_update() using the passed in @app.
+ * gs_app_set_progress() using the passed in @app.
  *
  * All functions can block, but should sent progress notifications, e.g. using
- * gs_plugin_progress_update() if they will take more than tens of milliseconds
+ * gs_app_set_progress() if they will take more than tens of milliseconds
  * to complete.
  *
  * On failure the error message returned will usually only be shown on the
@@ -584,10 +584,10 @@ gboolean   gs_plugin_app_set_rating               (GsPlugin       *plugin,
  * Update the application live.
  *
  * Plugins are expected to send progress notifications to the UI using
- * gs_plugin_progress_update() using the passed in @app.
+ * gs_app_set_progress() using the passed in @app.
  *
  * All functions can block, but should sent progress notifications, e.g. using
- * gs_plugin_progress_update() if they will take more than tens of milliseconds
+ * gs_app_set_progress() if they will take more than tens of milliseconds
  * to complete.
  *
  * On failure the error message returned will usually only be shown on the
@@ -614,7 +614,7 @@ gboolean     gs_plugin_update_app                   (GsPlugin       *plugin,
  * Starts downloading a distribution upgrade in the background.
  *
  * All functions can block, but should sent progress notifications, e.g. using
- * gs_plugin_progress_update() if they will take more than tens of milliseconds
+ * gs_app_set_progress() if they will take more than tens of milliseconds
  * to complete.
  *
  * Returns: %TRUE for success or if not relevant
@@ -775,7 +775,7 @@ gboolean     gs_plugin_review_dismiss               (GsPlugin       *plugin,
  * This is used to pre-download package updates and firmware.
  *
  * All functions can block, but should sent progress notifications, e.g. using
- * gs_plugin_progress_update() if they will take more than tens of milliseconds
+ * gs_app_set_progress() if they will take more than tens of milliseconds
  * to complete.
  *
  * Returns: %TRUE for success or if not relevant
diff --git a/src/gs-utils.c b/src/gs-utils.c
index 3904302..dd02735 100644
--- a/src/gs-utils.c
+++ b/src/gs-utils.c
@@ -314,7 +314,7 @@ gs_utils_get_desktop_app_info (const gchar *id)
 /**
  * gs_utils_symlink:
  * @target: the full path of the symlink to create
- * @source: where the symlink should point to
+ * @linkpath: where the symlink should point to
  * @error: A #GError, or %NULL
  *
  * Creates a symlink that can cross filesystem boundaries.