diff --git a/Flow.Launcher.Plugin/ActionContext.cs b/Flow.Launcher.Plugin/ActionContext.cs
index d898972da..d6ba4894e 100644
--- a/Flow.Launcher.Plugin/ActionContext.cs
+++ b/Flow.Launcher.Plugin/ActionContext.cs
@@ -2,18 +2,47 @@
namespace Flow.Launcher.Plugin
{
+ ///
+ /// Context provided as a parameter when invoking a
+ /// or
+ ///
public class ActionContext
{
+ ///
+ /// Contains the press state of certain special keys.
+ ///
public SpecialKeyState SpecialKeyState { get; set; }
}
+ ///
+ /// Contains the press state of certain special keys.
+ ///
public class SpecialKeyState
{
+ ///
+ /// True if the Ctrl key is pressed.
+ ///
public bool CtrlPressed { get; set; }
+
+ ///
+ /// True if the Shift key is pressed.
+ ///
public bool ShiftPressed { get; set; }
+
+ ///
+ /// True if the Alt key is pressed.
+ ///
public bool AltPressed { get; set; }
+
+ ///
+ /// True if the Windows key is pressed.
+ ///
public bool WinPressed { get; set; }
+ ///
+ /// Get this object represented as a flag combination.
+ ///
+ ///
public ModifierKeys ToModifierKeys()
{
return (CtrlPressed ? ModifierKeys.Control : ModifierKeys.None) |
diff --git a/Flow.Launcher.Plugin/Interfaces/IContextMenu.cs b/Flow.Launcher.Plugin/Interfaces/IContextMenu.cs
index 5befbf5c9..06398fb1b 100644
--- a/Flow.Launcher.Plugin/Interfaces/IContextMenu.cs
+++ b/Flow.Launcher.Plugin/Interfaces/IContextMenu.cs
@@ -1,9 +1,18 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
namespace Flow.Launcher.Plugin
{
+ ///
+ /// Adds support for presenting additional options for a given from a context menu.
+ ///
public interface IContextMenu : IFeatures
{
+ ///
+ /// Load context menu items for the given result.
+ ///
+ ///
+ /// The for which the user has activated the context menu.
+ ///
List LoadContextMenus(Result selectedResult);
}
}
\ No newline at end of file
diff --git a/Flow.Launcher.Plugin/Interfaces/IPluginI18n.cs b/Flow.Launcher.Plugin/Interfaces/IPluginI18n.cs
index 61662b671..bbc998fcb 100644
--- a/Flow.Launcher.Plugin/Interfaces/IPluginI18n.cs
+++ b/Flow.Launcher.Plugin/Interfaces/IPluginI18n.cs
@@ -1,4 +1,4 @@
-using System.Globalization;
+using System.Globalization;
namespace Flow.Launcher.Plugin
{
@@ -7,8 +7,14 @@ namespace Flow.Launcher.Plugin
///
public interface IPluginI18n : IFeatures
{
+ ///
+ /// Get a localised version of the plugin's title
+ ///
string GetTranslatedPluginTitle();
+ ///
+ /// Get a localised version of the plugin's description
+ ///
string GetTranslatedPluginDescription();
///
diff --git a/Flow.Launcher.Plugin/Interfaces/ISavable.cs b/Flow.Launcher.Plugin/Interfaces/ISavable.cs
index 2d13eaa6e..77bd304e4 100644
--- a/Flow.Launcher.Plugin/Interfaces/ISavable.cs
+++ b/Flow.Launcher.Plugin/Interfaces/ISavable.cs
@@ -1,12 +1,18 @@
-namespace Flow.Launcher.Plugin
+namespace Flow.Launcher.Plugin
{
///
- /// Save addtional plugin data. Inherit this interface if additional data e.g. cache needs to be saved,
- /// Otherwise if LoadSettingJsonStorage or SaveSettingJsonStorage has been callded,
- /// plugin settings will be automatically saved (see Flow.Launcher/PublicAPIInstance.SavePluginSettings) by Flow
+ /// Inherit this interface if additional data e.g. cache needs to be saved.
///
+ ///
+ /// For storing plugin settings, prefer
+ /// or .
+ /// Once called, your settings will be automatically saved by Flow.
+ ///
public interface ISavable : IFeatures
{
+ ///
+ /// Save additional plugin data, such as cache.
+ ///
void Save();
}
}
\ No newline at end of file
diff --git a/Flow.Launcher.Plugin/PluginInitContext.cs b/Flow.Launcher.Plugin/PluginInitContext.cs
index 233ead8f9..f040752bd 100644
--- a/Flow.Launcher.Plugin/PluginInitContext.cs
+++ b/Flow.Launcher.Plugin/PluginInitContext.cs
@@ -1,5 +1,8 @@
namespace Flow.Launcher.Plugin
{
+ ///
+ /// Carries data passed to a plugin when it gets initialized.
+ ///
public class PluginInitContext
{
public PluginInitContext()
@@ -12,6 +15,9 @@
API = api;
}
+ ///
+ /// The metadata of the plugin being initialized.
+ ///
public PluginMetadata CurrentPluginMetadata { get; internal set; }
///