Skip to content

Commit 59411a2

Browse files
committed
Added CSTOJSOptions comments.
1 parent 2ef37a6 commit 59411a2

1 file changed

Lines changed: 42 additions & 1 deletion

File tree

CSharpToJavaScript/CSTOJSOptions.cs

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,58 @@ public class CSTOJSOptions
1212

1313
/// <summary>
1414
/// Output path for javascript file.
15-
/// Default: Directory.GetCurrentDirectory()
1615
/// </summary>
16+
/// <value>
17+
/// Default: <c>Directory.GetCurrentDirectory()</c>
18+
/// </value>
1719
public string OutPutPath { get; set; } = Directory.GetCurrentDirectory();
20+
/// <summary>
21+
/// Output javascript file name.
22+
/// </summary>
23+
/// <value>
24+
/// Default: <c>main.js</c>
25+
/// </value>
1826
public string OutPutFileName { get; set; } = "main.js";
1927

28+
/// <summary>
29+
/// Self-explanatory, Use var over let.
30+
/// </summary>
31+
/// <value>
32+
/// Default: <c>false</c>
33+
/// </value>
2034
public bool UseVarOverLet { get; set; } = false;
2135

36+
/// <summary>
37+
/// List of custom names to convert.
38+
/// Example: new("Console","console").
39+
/// Will convert "Console" to "console".
40+
/// </summary>
41+
/// <value>
42+
/// Default: <c>new()</c>
43+
/// </value>
2244
public List<Tuple<string, string>> CustomCSNamesToJS { get; set; } = new();
45+
/// <summary>
46+
/// List of types to convert.
47+
/// Example: Similar to CustomCSNamesToJS, but convers the type. You need to use <c>ToAttribute</c>
48+
/// </summary>
49+
/// <value>
50+
/// Default: <c>new()</c>
51+
/// </value>
2352
public List<Type> CustomCSTypesToJS { get; set; } = new();
2453

54+
/// <summary>
55+
/// Add a <c>StringBulder</c> to the front of a javascript file.
56+
/// </summary>
57+
/// <value>
58+
/// Default: <c>new()</c>
59+
/// </value>
2560
public StringBuilder AddSBInFront { get; set; } = new();
61+
/// <summary>
62+
/// Add a <c>StringBulder</c> to the end of a javascript file.
63+
/// </summary>
64+
/// <value>
65+
/// Default: <c>new()</c>
66+
/// </value>
2667
public StringBuilder AddSBInEnd { get; set; } = new();
2768

2869
public CSTOJSOptions()

0 commit comments

Comments
 (0)