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] 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; }