[gnome-software/mwleeds/pwa-plugin: 106/107] lib: Fix some docs
- From: Phaedrus Leeds <mwleeds src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-software/mwleeds/pwa-plugin: 106/107] lib: Fix some docs
- Date: Fri, 10 Dec 2021 00:35:38 +0000 (UTC)
commit b5d9b074b02cb10575ffd7fcf43deeb3f7c06132
Author: Phaedrus Leeds <mwleeds protonmail com>
Date: Thu Dec 9 14:35:32 2021 -0800
lib: Fix some docs
lib/gs-plugin-vfuncs.h | 3 ++-
lib/gs-plugin.h | 2 +-
2 files changed, 3 insertions(+), 2 deletions(-)
---
diff --git a/lib/gs-plugin-vfuncs.h b/lib/gs-plugin-vfuncs.h
index 65764578c..9389dfc41 100644
--- a/lib/gs-plugin-vfuncs.h
+++ b/lib/gs-plugin-vfuncs.h
@@ -36,7 +36,8 @@ G_BEGIN_DECLS
*
* The init function for that type should initialize the plugin. If the plugin
* should not be run then gs_plugin_set_enabled() should be called from the
- * init function.
+ * init function. The plugin will also be disabled if the init function returns
+ * an error.
*
* NOTE: Do not do any failable actions in the plugin class’ init function; use
* #GsPluginClass.setup_async instead.
diff --git a/lib/gs-plugin.h b/lib/gs-plugin.h
index 48e7c12ff..4db88f697 100644
--- a/lib/gs-plugin.h
+++ b/lib/gs-plugin.h
@@ -32,7 +32,7 @@ G_DECLARE_DERIVABLE_TYPE (GsPlugin, gs_plugin, GS, PLUGIN, GObject)
* the #GsPlugin object is constructed, before it’s used for anything. It
* should do any long-running setup operations which the plugin needs, such as
* file or network access. It may be %NULL if the plugin doesn’t need to be
- * explicitly shut down. It is not called if the plugin is disabled during
+ * explicitly set up. It is not called if the plugin is disabled during
* construction.
* @setup_finish: (nullable): Finish method for @setup_async. Must be
* implemented if @setup_async is implemented.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]