Skip to content

Commit 03cedcc

Browse files
committed
AllowedLanguage documentation
1 parent dbe2151 commit 03cedcc

File tree

3 files changed

+25
-885
lines changed

3 files changed

+25
-885
lines changed
Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,63 @@
11
namespace Flow.Launcher.Plugin
22
{
3-
#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
3+
/// <summary>
4+
/// Allowed plugin languages
5+
/// </summary>
46
public static class AllowedLanguage
57
{
8+
/// <summary>
9+
/// Python
10+
/// </summary>
611
public static string Python
712
{
813
get { return "PYTHON"; }
914
}
1015

16+
/// <summary>
17+
/// C#
18+
/// </summary>
1119
public static string CSharp
1220
{
1321
get { return "CSHARP"; }
1422
}
1523

24+
/// <summary>
25+
/// F#
26+
/// </summary>
1627
public static string FSharp
1728
{
1829
get { return "FSHARP"; }
1930
}
2031

32+
/// <summary>
33+
/// Standard .exe
34+
/// </summary>
2135
public static string Executable
2236
{
2337
get { return "EXECUTABLE"; }
2438
}
2539

40+
/// <summary>
41+
/// Determines if this language is a .NET language
42+
/// </summary>
43+
/// <param name="language"></param>
44+
/// <returns></returns>
2645
public static bool IsDotNet(string language)
2746
{
2847
return language.ToUpper() == CSharp
2948
|| language.ToUpper() == FSharp;
3049
}
3150

51+
/// <summary>
52+
/// Determines if this language is supported
53+
/// </summary>
54+
/// <param name="language"></param>
55+
/// <returns></returns>
3256
public static bool IsAllowed(string language)
3357
{
3458
return IsDotNet(language)
3559
|| language.ToUpper() == Python.ToUpper()
3660
|| language.ToUpper() == Executable.ToUpper();
3761
}
3862
}
39-
#pragma warning restore CS1591 // Missing XML comment for publicly visible type or member
4063
}

0 commit comments

Comments
 (0)