@@ -10,11 +10,11 @@ public class Result
1010 {
1111
1212 private string _pluginDirectory ;
13-
13+
1414 private string _icoPath ;
1515
1616 /// <summary>
17- /// Provides the title of the result. This is always required.
17+ /// The title of the result. This is always required.
1818 /// </summary>
1919 public string Title { get ; set ; }
2020
@@ -36,6 +36,9 @@ public class Result
3636 /// </summary>
3737 public string AutoCompleteText { get ; set ; }
3838
39+ /// <summary>
40+ /// Image Displayed on the result
41+ /// </summary>
3942 public string IcoPath
4043 {
4144 get { return _icoPath ; }
@@ -60,16 +63,22 @@ public string IcoPath
6063 public IconDelegate Icon ;
6164
6265 /// <summary>
63- /// Information for Glyph Icon
66+ /// Information for Glyph Icon (Prioritized than IcoPath/Icon if user enable Glyph Icons)
6467 /// </summary>
65- public GlyphInfo Glyph { get ; init ; }
68+ public GlyphInfo Glyph { get ; init ; }
6669
6770
6871 /// <summary>
69- /// return true to hide flowlauncher after select result
72+ /// Delegate activated when result is been selected
73+ /// <returns>
74+ /// true to hide flowlauncher after select result
75+ /// </returns>
7076 /// </summary>
7177 public Func < ActionContext , bool > Action { get ; set ; }
7278
79+ /// <summary>
80+ /// Priority of the current result
81+ /// </summary>
7382 public int Score { get ; set ; }
7483
7584 /// <summary>
@@ -83,9 +92,9 @@ public string IcoPath
8392 public IList < int > SubTitleHighlightData { get ; set ; }
8493
8594 /// <summary>
86- /// Only results that originQuery match with current query will be displayed in the panel
95+ /// Query information associated with the result
8796 /// </summary>
88- internal Query OriginQuery { get ; set ; }
97+ public Query OriginQuery { get ; set ; }
8998
9099 /// <summary>
91100 /// Plugin directory
@@ -103,6 +112,7 @@ public string PluginDirectory
103112 }
104113 }
105114
115+ /// <inheritdoc />
106116 public override bool Equals ( object obj )
107117 {
108118 var r = obj as Result ;
@@ -116,22 +126,25 @@ public override bool Equals(object obj)
116126 return equality ;
117127 }
118128
129+ /// <inheritdoc />
119130 public override int GetHashCode ( )
120131 {
121132 var hashcode = ( Title ? . GetHashCode ( ) ?? 0 ) ^
122133 ( SubTitle ? . GetHashCode ( ) ?? 0 ) ;
123134 return hashcode ;
124135 }
125136
137+ /// <inheritdoc />
126138 public override string ToString ( )
127139 {
128140 return Title + SubTitle ;
129141 }
130142
131- public Result ( ) { }
132-
133143 /// <summary>
134144 /// Additional data associate with this result
145+ /// <example>
146+ /// As external information for ContextMenu
147+ /// </example>
135148 /// </summary>
136149 public object ContextData { get ; set ; }
137150
0 commit comments