Skip to content

Commit f6d8d3e

Browse files
authored
Merge pull request #938 from Flow-Launcher/UpdateXMLDoc
Update XML Docs
2 parents 7dd5c12 + ff3224b commit f6d8d3e

File tree

3 files changed

+32
-10
lines changed

3 files changed

+32
-10
lines changed

Flow.Launcher.Plugin/Flow.Launcher.Plugin.csproj

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<Project Sdk="Microsoft.NET.Sdk">
1+
<Project Sdk="Microsoft.NET.Sdk">
22

33
<PropertyGroup>
44
<TargetFramework>net5.0-windows</TargetFramework>
@@ -42,6 +42,7 @@
4242
<WarningLevel>4</WarningLevel>
4343
<PlatformTarget>AnyCPU</PlatformTarget>
4444
<Prefer32Bit>false</Prefer32Bit>
45+
<DocumentationFile>..\Output\Debug\Flow.Launcher.Plugin.xml</DocumentationFile>
4546
</PropertyGroup>
4647

4748
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">

Flow.Launcher.Plugin/GlyphInfo.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,10 @@
77

88
namespace Flow.Launcher.Plugin
99
{
10+
/// <summary>
11+
/// Text with FontFamily specified
12+
/// </summary>
13+
/// <param name="FontFamily">Font Family of this Glyph</param>
14+
/// <param name="Glyph">Text/Unicode of the Glyph</param>
1015
public record GlyphInfo(string FontFamily, string Glyph);
1116
}

Flow.Launcher.Plugin/Result.cs

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -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,11 @@ public class Result
3636
/// </summary>
3737
public string AutoCompleteText { get; set; }
3838

39+
/// <summary>
40+
/// Image Displayed on the result
41+
/// <value>Relative Path to the Image File</value>
42+
/// <remarks>GlyphInfo is prioritized if not null</remarks>
43+
/// </summary>
3944
public string IcoPath
4045
{
4146
get { return _icoPath; }
@@ -60,16 +65,23 @@ public string IcoPath
6065
public IconDelegate Icon;
6166

6267
/// <summary>
63-
/// Information for Glyph Icon
68+
/// Information for Glyph Icon (Prioritized than IcoPath/Icon if user enable Glyph Icons)
6469
/// </summary>
65-
public GlyphInfo Glyph { get; init; }
70+
public GlyphInfo Glyph { get; init; }
6671

6772

6873
/// <summary>
69-
/// return true to hide flowlauncher after select result
74+
/// Delegate. An action to take in the form of a function call when the result has been selected
75+
/// <returns>
76+
/// true to hide flowlauncher after select result
77+
/// </returns>
7078
/// </summary>
7179
public Func<ActionContext, bool> Action { get; set; }
7280

81+
/// <summary>
82+
/// Priority of the current result
83+
/// <value>default: 0</value>
84+
/// </summary>
7385
public int Score { get; set; }
7486

7587
/// <summary>
@@ -81,7 +93,7 @@ public string IcoPath
8193
public IList<int> SubTitleHighlightData { get; set; }
8294

8395
/// <summary>
84-
/// Only results that originQuery match with current query will be displayed in the panel
96+
/// Query information associated with the result
8597
/// </summary>
8698
internal Query OriginQuery { get; set; }
8799

@@ -101,6 +113,7 @@ public string PluginDirectory
101113
}
102114
}
103115

116+
/// <inheritdoc />
104117
public override bool Equals(object obj)
105118
{
106119
var r = obj as Result;
@@ -113,22 +126,25 @@ public override bool Equals(object obj)
113126
return equality;
114127
}
115128

129+
/// <inheritdoc />
116130
public override int GetHashCode()
117131
{
118132
var hashcode = (Title?.GetHashCode() ?? 0) ^
119133
(SubTitle?.GetHashCode() ?? 0);
120134
return hashcode;
121135
}
122136

137+
/// <inheritdoc />
123138
public override string ToString()
124139
{
125140
return Title + SubTitle;
126141
}
127142

128-
public Result() { }
129-
130143
/// <summary>
131-
/// Additional data associate with this result
144+
/// Additional data associated with this result
145+
/// <example>
146+
/// As external information for ContextMenu
147+
/// </example>
132148
/// </summary>
133149
public object ContextData { get; set; }
134150

0 commit comments

Comments
 (0)