From 9cd30112fe6d9056a211e8f9dabe17c056e429a9 Mon Sep 17 00:00:00 2001
From: Jack251970 <1160210343@qq.com>
Date: Sun, 23 Feb 2025 21:28:03 +0800
Subject: [PATCH] Add documents for plugin metadata

---
 Flow.Launcher.Plugin/PluginMetadata.cs | 98 ++++++++++++++++++++++++--
 1 file changed, 91 insertions(+), 7 deletions(-)

diff --git a/Flow.Launcher.Plugin/PluginMetadata.cs b/Flow.Launcher.Plugin/PluginMetadata.cs
index 15ba2deaa..6dc8acc63 100644
--- a/Flow.Launcher.Plugin/PluginMetadata.cs
+++ b/Flow.Launcher.Plugin/PluginMetadata.cs
@@ -4,23 +4,74 @@ using System.Text.Json.Serialization;
 
 namespace Flow.Launcher.Plugin
 {
+    /// <summary>
+    /// Plugin metadata
+    /// </summary>
     public class PluginMetadata : BaseModel
     {
         private string _pluginDirectory;
+
+        /// <summary>
+        /// Plugin ID.
+        /// </summary>
         public string ID { get; set; }
+
+        /// <summary>
+        /// Plugin name.
+        /// </summary>
         public string Name { get; set; }
+
+        /// <summary>
+        /// Plugin author.
+        /// </summary>
         public string Author { get; set; }
+
+        /// <summary>
+        /// Plugin version.
+        /// </summary>
         public string Version { get; set; }
+
+        /// <summary>
+        /// Plugin language.
+        /// See <see cref="AllowedLanguage"/>
+        /// </summary>
         public string Language { get; set; }
+
+        /// <summary>
+        /// Plugin description.
+        /// </summary>
         public string Description { get; set; }
+
+        /// <summary>
+        /// Plugin website.
+        /// </summary>
         public string Website { get; set; }
+
+        /// <summary>
+        /// Whether plugin is disabled.
+        /// </summary>
         public bool Disabled { get; set; }
-        public string ExecuteFilePath { get; private set;}
+
+        /// <summary>
+        /// Plugin execute file path.
+        /// </summary>
+        public string ExecuteFilePath { get; private set; }
+
+        /// <summary>
+        /// Plugin execute file name.
+        /// </summary>
         public string ExecuteFileName { get; set; }
 
+        /// <summary>
+        /// Plugin assembly name.
+        /// Only available for .Net plugins.
+        /// </summary>
         [JsonIgnore]
         public string AssemblyName { get; internal set; }
 
+        /// <summary>
+        /// Plugin source directory.
+        /// </summary>
         public string PluginDirectory
         {
             get => _pluginDirectory;
@@ -32,36 +83,69 @@ namespace Flow.Launcher.Plugin
             }
         }
 
+        /// <summary>
+        /// The first action keyword of plugin.
+        /// </summary>
         public string ActionKeyword { get; set; }
 
+        /// <summary>
+        /// All action keywords of plugin.
+        /// </summary>
         public List<string> ActionKeywords { get; set; }
 
+        /// <summary>
+        /// Plugin icon path.
+        /// </summary>
         public string IcoPath { get; set;}
-        
-        public override string ToString()
-        {
-            return Name;
-        }
 
+        /// <summary>
+        /// Plugin priority.
+        /// </summary>
         [JsonIgnore]
         public int Priority { get; set; }
 
         /// <summary>
-        /// Init time include both plugin load time and init time
+        /// Init time include both plugin load time and init time.
         /// </summary>
         [JsonIgnore]
         public long InitTime { get; set; }
 
+        /// <summary>
+        /// Average query time.
+        /// </summary>
         [JsonIgnore]
         public long AvgQueryTime { get; set; }
 
+        /// <summary>
+        /// Query count.
+        /// </summary>
         [JsonIgnore]
         public int QueryCount { get; set; }
 
+        /// <summary>
+        /// The path to the plugin settings directory.
+        /// It is used to store plugin settings files and data files.
+        /// When plugin is deleted, FL will ask users whether to keep its settings.
+        /// If users do not want to keep, this directory will be deleted.
+        /// </summary>
         [JsonIgnore]
         public string PluginSettingsDirectoryPath { get; internal set; }
 
+        /// <summary>
+        /// The path to the plugin cache directory.
+        /// It is used to store cache files.
+        /// When plugin is deleted, this directory will be deleted as well.
+        /// </summary>
         [JsonIgnore]
         public string PluginCacheDirectoryPath { get; internal set; }
+
+        /// <summary>
+        /// Convert <see cref="PluginMetadata"/> to string.
+        /// </summary>
+        /// <returns></returns>
+        public override string ToString()
+        {
+            return Name;
+        }
     }
 }