From 9bad05043a3d6fb2520c89dc93e378df39bd1932 Mon Sep 17 00:00:00 2001
From: Hongtao Zhang <hongtao_zhang@outlook.com>
Date: Wed, 29 Dec 2021 13:39:32 -0600
Subject: [PATCH 1/9] Include Flow.Launcher.Plguin xml document when debug

---
 Flow.Launcher.Plugin/Flow.Launcher.Plugin.csproj | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Flow.Launcher.Plugin/Flow.Launcher.Plugin.csproj b/Flow.Launcher.Plugin/Flow.Launcher.Plugin.csproj
index 7ce2fc8fd..8bdb861f2 100644
--- a/Flow.Launcher.Plugin/Flow.Launcher.Plugin.csproj
+++ b/Flow.Launcher.Plugin/Flow.Launcher.Plugin.csproj
@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>net5.0-windows</TargetFramework>
@@ -42,6 +42,7 @@
     <WarningLevel>4</WarningLevel>
     <PlatformTarget>AnyCPU</PlatformTarget>
     <Prefer32Bit>false</Prefer32Bit>
+    <DocumentationFile>..\Output\Debug\Flow.Launcher.Plugin.xml</DocumentationFile>
   </PropertyGroup>
   
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">

From 73a605528a200f8f0966d7d15a7464253e662f67 Mon Sep 17 00:00:00 2001
From: Hongtao Zhang <hongtao_zhang@outlook.com>
Date: Wed, 29 Dec 2021 13:39:39 -0600
Subject: [PATCH 2/9] Update xml docs

---
 Flow.Launcher.Plugin/GlyphInfo.cs |  5 +++++
 Flow.Launcher.Plugin/Result.cs    | 31 ++++++++++++++++++++++---------
 2 files changed, 27 insertions(+), 9 deletions(-)

diff --git a/Flow.Launcher.Plugin/GlyphInfo.cs b/Flow.Launcher.Plugin/GlyphInfo.cs
index d24624d8f..730046e1d 100644
--- a/Flow.Launcher.Plugin/GlyphInfo.cs
+++ b/Flow.Launcher.Plugin/GlyphInfo.cs
@@ -7,5 +7,10 @@ using System.Windows.Media;
 
 namespace Flow.Launcher.Plugin
 {
+    /// <summary>
+    /// Text with FontFamily specified
+    /// </summary>
+    /// <param name="FontFamily">Font Family of this Glyph</param>
+    /// <param name="Glyph">Text/Unicode of the Glyph</param>
     public record GlyphInfo(string FontFamily, string Glyph);
 }
diff --git a/Flow.Launcher.Plugin/Result.cs b/Flow.Launcher.Plugin/Result.cs
index 29f8198ab..4a0715c27 100644
--- a/Flow.Launcher.Plugin/Result.cs
+++ b/Flow.Launcher.Plugin/Result.cs
@@ -10,11 +10,11 @@ namespace Flow.Launcher.Plugin
     {
 
         private string _pluginDirectory;
-        
+
         private string _icoPath;
 
         /// <summary>
-        /// Provides the title of the result. This is always required.
+        /// The title of the result. This is always required.
         /// </summary>
         public string Title { get; set; }
 
@@ -36,6 +36,9 @@ namespace Flow.Launcher.Plugin
         /// </summary>
         public string AutoCompleteText { get; set; }
 
+        /// <summary>
+        /// Image Displayed on the result
+        /// </summary>
         public string IcoPath
         {
             get { return _icoPath; }
@@ -60,16 +63,22 @@ namespace Flow.Launcher.Plugin
         public IconDelegate Icon;
 
         /// <summary>
-        /// Information for Glyph Icon
+        /// Information for Glyph Icon (Prioritized than IcoPath/Icon if user enable Glyph Icons)
         /// </summary>
-        public GlyphInfo Glyph { get; init; } 
+        public GlyphInfo Glyph { get; init; }
 
 
         /// <summary>
-        /// return true to hide flowlauncher after select result
+        /// Delegate activated when result is been selected
+        /// <returns>
+        /// true to hide flowlauncher after select result
+        /// </returns>
         /// </summary>
         public Func<ActionContext, bool> Action { get; set; }
 
+        /// <summary>
+        /// Priority of the current result
+        /// </summary>
         public int Score { get; set; }
 
         /// <summary>
@@ -83,9 +92,9 @@ namespace Flow.Launcher.Plugin
         public IList<int> SubTitleHighlightData { get; set; }
 
         /// <summary>
-        /// Only results that originQuery match with current query will be displayed in the panel
+        /// Query information associated with the result
         /// </summary>
-        internal Query OriginQuery { get; set; }
+        public Query OriginQuery { get; set; }
 
         /// <summary>
         /// Plugin directory
@@ -103,6 +112,7 @@ namespace Flow.Launcher.Plugin
             }
         }
 
+        /// <inheritdoc />
         public override bool Equals(object obj)
         {
             var r = obj as Result;
@@ -116,6 +126,7 @@ namespace Flow.Launcher.Plugin
             return equality;
         }
 
+        /// <inheritdoc />
         public override int GetHashCode()
         {
             var hashcode = (Title?.GetHashCode() ?? 0) ^
@@ -123,15 +134,17 @@ namespace Flow.Launcher.Plugin
             return hashcode;
         }
 
+        /// <inheritdoc />
         public override string ToString()
         {
             return Title + SubTitle;
         }
 
-        public Result() { }
-
         /// <summary>
         /// Additional data associate with this result
+        /// <example>
+        /// As external information for ContextMenu
+        /// </example>
         /// </summary>
         public object ContextData { get; set; }
 

From b819c79c8deab8677128c48ac7fe1e0d57210972 Mon Sep 17 00:00:00 2001
From: Hongtao Zhang <hongtao_zhang@outlook.com>
Date: Wed, 29 Dec 2021 13:45:22 -0600
Subject: [PATCH 3/9] add score default value

---
 Flow.Launcher.Plugin/Result.cs | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Flow.Launcher.Plugin/Result.cs b/Flow.Launcher.Plugin/Result.cs
index 4a0715c27..7849dbe03 100644
--- a/Flow.Launcher.Plugin/Result.cs
+++ b/Flow.Launcher.Plugin/Result.cs
@@ -78,6 +78,7 @@ namespace Flow.Launcher.Plugin
 
         /// <summary>
         /// Priority of the current result
+        /// <value>default: 0</value>
         /// </summary>
         public int Score { get; set; }
 

From e9ceec5a11f587e965e461b328bfc0167ca77c81 Mon Sep 17 00:00:00 2001
From: Kevin Zhang <45326534+taooceros@users.noreply.github.com>
Date: Thu, 30 Dec 2021 11:33:34 -0600
Subject: [PATCH 4/9] Update Flow.Launcher.Plugin/Result.cs

Co-authored-by: Ioannis G. <jtgftw@gmail.com>
---
 Flow.Launcher.Plugin/Result.cs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Flow.Launcher.Plugin/Result.cs b/Flow.Launcher.Plugin/Result.cs
index 7849dbe03..e073f6d5c 100644
--- a/Flow.Launcher.Plugin/Result.cs
+++ b/Flow.Launcher.Plugin/Result.cs
@@ -69,7 +69,7 @@ namespace Flow.Launcher.Plugin
 
 
         /// <summary>
-        /// Delegate activated when result is been selected
+        /// Delegate activated when the result has been selected
         /// <returns>
         /// true to hide flowlauncher after select result
         /// </returns>

From 7bf4fdda7bd0908479912c3908cab1a1f84eea98 Mon Sep 17 00:00:00 2001
From: Kevin Zhang <45326534+taooceros@users.noreply.github.com>
Date: Thu, 30 Dec 2021 11:35:09 -0600
Subject: [PATCH 5/9] Update Flow.Launcher.Plugin/Result.cs

Co-authored-by: Ioannis G. <jtgftw@gmail.com>
---
 Flow.Launcher.Plugin/Result.cs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Flow.Launcher.Plugin/Result.cs b/Flow.Launcher.Plugin/Result.cs
index e073f6d5c..bdf515277 100644
--- a/Flow.Launcher.Plugin/Result.cs
+++ b/Flow.Launcher.Plugin/Result.cs
@@ -142,7 +142,7 @@ namespace Flow.Launcher.Plugin
         }
 
         /// <summary>
-        /// Additional data associate with this result
+        /// Additional data associated with this result
         /// <example>
         /// As external information for ContextMenu
         /// </example>

From 45bd31f1f928290d43f0239534cd82ad8bdc1b3b Mon Sep 17 00:00:00 2001
From: Hongtao Zhang <hongtao_zhang@outlook.com>
Date: Thu, 30 Dec 2021 15:56:13 -0600
Subject: [PATCH 6/9] update docs

---
 Flow.Launcher.Plugin/Result.cs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Flow.Launcher.Plugin/Result.cs b/Flow.Launcher.Plugin/Result.cs
index bdf515277..a73c23957 100644
--- a/Flow.Launcher.Plugin/Result.cs
+++ b/Flow.Launcher.Plugin/Result.cs
@@ -38,6 +38,8 @@ namespace Flow.Launcher.Plugin
 
         /// <summary>
         /// Image Displayed on the result
+        /// <value>Relative Path toward the Image File</value>
+        /// <remarks>GlyphInfo is prioritized if not null</remarks>
         /// </summary>
         public string IcoPath
         {

From ab61f5bf1d94efead99130e4249086d0a5be6431 Mon Sep 17 00:00:00 2001
From: Hongtao Zhang <hongtao_zhang@outlook.com>
Date: Thu, 30 Dec 2021 15:56:28 -0600
Subject: [PATCH 7/9] fix grammar

---
 Flow.Launcher.Plugin/Result.cs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Flow.Launcher.Plugin/Result.cs b/Flow.Launcher.Plugin/Result.cs
index a73c23957..1a2de3c4d 100644
--- a/Flow.Launcher.Plugin/Result.cs
+++ b/Flow.Launcher.Plugin/Result.cs
@@ -38,7 +38,7 @@ namespace Flow.Launcher.Plugin
 
         /// <summary>
         /// Image Displayed on the result
-        /// <value>Relative Path toward the Image File</value>
+        /// <value>Relative Path to the Image File</value>
         /// <remarks>GlyphInfo is prioritized if not null</remarks>
         /// </summary>
         public string IcoPath

From 1b1800ff5ef071e5fb2eff5dd7421700baeed8b6 Mon Sep 17 00:00:00 2001
From: Kevin Zhang <45326534+taooceros@users.noreply.github.com>
Date: Fri, 31 Dec 2021 10:59:53 -0600
Subject: [PATCH 8/9] Update Flow.Launcher.Plugin/Result.cs

Co-authored-by: Jeremy Wu <jeremy24wu@gmail.com>
---
 Flow.Launcher.Plugin/Result.cs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Flow.Launcher.Plugin/Result.cs b/Flow.Launcher.Plugin/Result.cs
index 1a2de3c4d..bc5c0270f 100644
--- a/Flow.Launcher.Plugin/Result.cs
+++ b/Flow.Launcher.Plugin/Result.cs
@@ -71,7 +71,7 @@ namespace Flow.Launcher.Plugin
 
 
         /// <summary>
-        /// Delegate activated when the result has been selected
+        /// Delegate. An action to take in the form of a function call when the result has been selected
         /// <returns>
         /// true to hide flowlauncher after select result
         /// </returns>

From ff3224bb342c63f6005a96a9cd03e953dbfc3171 Mon Sep 17 00:00:00 2001
From: Ioannis G <jtgftw@gmail.com>
Date: Sat, 1 Jan 2022 13:45:00 +0200
Subject: [PATCH 9/9] revert Result.OriginQuery to internal

---
 Flow.Launcher.Plugin/Result.cs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Flow.Launcher.Plugin/Result.cs b/Flow.Launcher.Plugin/Result.cs
index bc5c0270f..0cc0a6811 100644
--- a/Flow.Launcher.Plugin/Result.cs
+++ b/Flow.Launcher.Plugin/Result.cs
@@ -97,7 +97,7 @@ namespace Flow.Launcher.Plugin
         /// <summary>
         /// Query information associated with the result
         /// </summary>
-        public Query OriginQuery { get; set; }
+        internal Query OriginQuery { get; set; }
 
         /// <summary>
         /// Plugin directory