[geary/mjog/598-sent-email-sound: 2/6] Plugin: Fix some bad API docs



commit 45d05dd3f64b8e26482db636d7c307d86ba47854
Author: Michael Gratton <mike vee net>
Date:   Sat Mar 21 09:08:37 2020 +1100

    Plugin: Fix some bad API docs

 src/client/plugin/plugin-folder-extension.vala       | 8 ++++----
 src/client/plugin/plugin-notification-extension.vala | 4 ++--
 2 files changed, 6 insertions(+), 6 deletions(-)
---
diff --git a/src/client/plugin/plugin-folder-extension.vala b/src/client/plugin/plugin-folder-extension.vala
index 11722cae..eee857a0 100644
--- a/src/client/plugin/plugin-folder-extension.vala
+++ b/src/client/plugin/plugin-folder-extension.vala
@@ -29,10 +29,10 @@ public interface Plugin.FolderExtension : PluginBase {
 /**
  * Provides a context for folder plugins.
  *
- * The context provides an interface for folder plugins to
- * interface with the Geary client application. Plugins that implement
- * the plugins will be passed an instance of this class as the
- * `context` property.
+ * The context provides an interface for folder plugins to interface
+ * with the Geary client application. Plugins that implement the
+ * {@link FolderExtension} interface will be given an instance of this
+ * class.
  *
  * @see Plugin.FolderExtension.folders
  */
diff --git a/src/client/plugin/plugin-notification-extension.vala 
b/src/client/plugin/plugin-notification-extension.vala
index 230e98c7..aad10982 100644
--- a/src/client/plugin/plugin-notification-extension.vala
+++ b/src/client/plugin/plugin-notification-extension.vala
@@ -31,8 +31,8 @@ public interface Plugin.NotificationExtension : PluginBase {
  *
  * The context provides an interface for notification plugins to
  * interface with the Geary client application. Plugins that implement
- * the plugins will be passed an instance of this class as the
- * `context` property.
+ * the {@link NotificationExtension} interface will be given an
+ * instance of this class.
  *
  * Plugins should register folders they wish to monitor by calling
  * {@link start_monitoring_folder}. The context will then start


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]