Skip to content

Commit b87d7f9

Browse files
committed
Add XML comments
1 parent fa51cdd commit b87d7f9

File tree

9 files changed

+90
-31
lines changed

9 files changed

+90
-31
lines changed
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,33 @@
11
namespace ElectronNET.API.Entities
22
{
3+
/// <summary>
4+
///
5+
/// </summary>
36
public class AddRepresentationOptions
47
{
8+
/// <summary>
9+
/// Gets or sets the width
10+
/// </summary>
511
public int? Width { get; set; }
12+
13+
/// <summary>
14+
/// Gets or sets the height
15+
/// </summary>
616
public int? Height { get; set; }
17+
18+
/// <summary>
19+
/// Gets or sets the scalefactor
20+
/// </summary>
721
public float ScaleFactor { get; set; } = 1.0f;
22+
23+
/// <summary>
24+
/// Gets or sets the buffer
25+
/// </summary>
826
public byte[] Buffer { get; set; }
27+
28+
/// <summary>
29+
/// Gets or sets the dataURL
30+
/// </summary>
931
public string DataUrl { get; set; }
1032
}
1133
}
Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
using System;
2-
using System.Collections.Generic;
3-
using System.Text;
4-
5-
namespace ElectronNET.API.Entities
1+
namespace ElectronNET.API.Entities
62
{
3+
/// <summary>
4+
///
5+
/// </summary>
76
public class BitmapOptions
87
{
8+
/// <summary>
9+
/// Gets or sets the scale factor
10+
/// </summary>
911
public float ScaleFactor { get; set; } = 1.0f;
1012
}
1113
}
Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
1-
using System;
2-
using System.Collections.Generic;
3-
using System.Text;
4-
5-
namespace ElectronNET.API.Entities
1+
namespace ElectronNET.API.Entities
62
{
3+
/// <summary>
4+
///
5+
/// </summary>
76
public class CreateFromBitmapOptions
87
{
8+
/// <summary>
9+
/// Gets or sets the width
10+
/// </summary>
911
public int? Width { get; set; }
12+
13+
/// <summary>
14+
/// Gets or sets the height
15+
/// </summary>
1016
public int? Height { get; set; }
17+
18+
/// <summary>
19+
/// Gets or sets the scalefactor
20+
/// </summary>
1121
public float ScaleFactor { get; set; } = 1.0f;
1222
}
1323
}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
11
namespace ElectronNET.API.Entities
22
{
3+
/// <summary>
4+
///
5+
/// </summary>
36
public class CreateFromBufferOptions
47
{
8+
/// <summary>
9+
/// Gets or sets the width
10+
/// </summary>
511
public int? Width { get; set; }
12+
13+
/// <summary>
14+
/// Gets or sets the height
15+
/// </summary>
616
public int? Height { get; set; }
17+
18+
/// <summary>
19+
/// Gets or sets the scalefactor
20+
/// </summary>
721
public float ScaleFactor { get; set; } = 1.0f;
822
}
923
}

ElectronNET.API/Entities/NativeImage.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,6 @@ public bool IsEmpty()
265265
/// <summary>
266266
/// Deprecated. Whether the image is a template image.
267267
/// </summary>
268-
/// <param name="option"></param>
269268
public bool IsTemplateImage => _isTemplateImage;
270269

271270
/// <summary>

ElectronNET.API/Entities/ResizeOptions.cs

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
1-
using System;
2-
using System.Collections.Generic;
3-
using System.Text;
4-
5-
namespace ElectronNET.API.Entities
1+
namespace ElectronNET.API.Entities
62
{
3+
/// <summary>
4+
///
5+
/// </summary>
76
public class ResizeOptions
87
{
8+
/// <summary>
9+
/// Gets or sets the width
10+
/// </summary>
911
public int? Width { get; set; }
12+
13+
/// <summary>
14+
/// Gets or sets the height
15+
/// </summary>
1016
public int? Height { get; set; }
1117

1218
/// <summary>
Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
using System;
2-
using System.Collections.Generic;
3-
using System.Text;
4-
5-
namespace ElectronNET.API.Entities
1+
namespace ElectronNET.API.Entities
62
{
3+
/// <summary>
4+
///
5+
/// </summary>
76
public class ToBitmapOptions
87
{
8+
/// <summary>
9+
/// Gets or sets the scalefactor
10+
/// </summary>
911
public float ScaleFactor { get; set; } = 1.0f;
1012
}
1113
}
Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
using System;
2-
using System.Collections.Generic;
3-
using System.Text;
4-
5-
namespace ElectronNET.API.Entities
1+
namespace ElectronNET.API.Entities
62
{
3+
/// <summary>
4+
///
5+
/// </summary>
76
public class ToDataUrlOptions
87
{
8+
/// <summary>
9+
/// Gets or sets the scalefactor
10+
/// </summary>
911
public float ScaleFactor { get; set; } = 1.0f;
1012
}
1113
}
Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
using System;
2-
using System.Collections.Generic;
3-
using System.Text;
4-
5-
namespace ElectronNET.API.Entities
1+
namespace ElectronNET.API.Entities
62
{
3+
/// <summary>
4+
///
5+
/// </summary>
76
public class ToPNGOptions
87
{
8+
/// <summary>
9+
/// Gets or sets the scalefactor
10+
/// </summary>
911
public float ScaleFactor { get; set; } = 1.0f;
1012
}
1113
}

0 commit comments

Comments
 (0)