Skip to content

Commit dd1deb0

Browse files
authored
Enable SA1602 (#2055)
1 parent c87f25b commit dd1deb0

File tree

9 files changed

+131
-3
lines changed

9 files changed

+131
-3
lines changed

lib/PuppeteerSharp.ruleset

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
<Rule Id="SA1124" Action="Error" /> <!-- Error SA1124: Don't use regions-->
2525
<Rule Id="SA1009" Action="Error" /> <!-- Error SA1009: Closing parenthesis should not be preceded by a space. (SA1009)-->
2626
<Rule Id="SA1413" Action="Error" /> <!-- Error SA1413: Use trailing comma in multi-line initializers (SA1413)-->
27-
<Rule Id="SA1602" Action="None" /> <!-- Error SA1602: Enumeration items should be documented (SA1602)-->
27+
<Rule Id="SA1602" Action="Error" /> <!-- Error SA1602: Enumeration items should be documented (SA1602)-->
2828
<Rule Id="SA1005" Action="Error" /> <!-- Error SA1005: Single line comment should begin with a space. (SA1005)-->
2929
<Rule Id="SA1203" Action="Error" /> <!-- Error SA1203: Constant fields should appear before non-constant fields (SA1203)-->
3030
<Rule Id="SA1720" Action="Error" /> <!-- Error SA1720: Name contains type-->

lib/PuppeteerSharp/DOMWorldType.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,20 @@ namespace PuppeteerSharp
77
[JsonConverter(typeof(FlexibleStringEnumConverter), Other)]
88
internal enum DOMWorldType
99
{
10+
/// <summary>
11+
/// Other type
12+
/// </summary>
1013
Other,
14+
15+
/// <summary>
16+
/// Isolated type
17+
/// </summary>
1118
[EnumMember(Value = "isolated")]
1219
Isolated,
20+
21+
/// <summary>
22+
/// Default type
23+
/// </summary>
1324
[EnumMember(Value = "default")]
1425
Default,
1526
}

lib/PuppeteerSharp/Helpers/Linux/FileAccessPermissions.cs

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,23 +5,74 @@ namespace PuppeteerSharp.Helpers.Linux
55
[Flags]
66
internal enum FileAccessPermissions : uint
77
{
8+
/// <summary>
9+
/// Other execution permission
10+
/// </summary>
811
OtherExecute = 1,
12+
13+
/// <summary>
14+
/// Other write permission
15+
/// </summary>
916
OtherWrite = 2,
17+
18+
/// <summary>
19+
/// Other read permission
20+
/// </summary>
1021
OtherRead = 4,
1122

23+
/// <summary>
24+
/// Group execution permission
25+
/// </summary>
1226
GroupExecute = 8,
27+
28+
/// <summary>
29+
/// Group write permission
30+
/// </summary>
1331
GroupWrite = 16,
32+
33+
/// <summary>
34+
/// Group read permission
35+
/// </summary>
1436
GroupRead = 32,
1537

38+
/// <summary>
39+
/// User execution permission
40+
/// </summary>
1641
UserExecute = 64,
42+
43+
/// <summary>
44+
/// User writer permission
45+
/// </summary>
1746
UserWrite = 128,
47+
48+
/// <summary>
49+
/// User read permission
50+
/// </summary>
1851
UserRead = 256,
1952

53+
/// <summary>
54+
/// Other read, write and execution permissions
55+
/// </summary>
2056
OtherReadWriteExecute = OtherRead | OtherWrite | OtherExecute,
57+
58+
/// <summary>
59+
/// Group read, write and execution permissions
60+
/// </summary>
2161
GroupReadWriteExecute = GroupRead | GroupWrite | GroupExecute,
62+
63+
/// <summary>
64+
/// User read, write and execution permissions
65+
/// </summary>
2266
UserReadWriteExecute = UserRead | UserWrite | UserExecute,
2367

68+
/// <summary>
69+
/// Default permissions
70+
/// </summary>
2471
DefaultPermissions = OtherWrite | OtherRead | GroupWrite | GroupRead | UserWrite | UserRead,
72+
73+
/// <summary>
74+
/// All permissions
75+
/// </summary>
2576
AllPermissions = DefaultPermissions | OtherExecute | GroupExecute | UserExecute,
2677
}
2778
}

lib/PuppeteerSharp/Input/PointerType.cs

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using System.Runtime.Serialization;
1+
using System.Runtime.Serialization;
22
using Newtonsoft.Json;
33
using Newtonsoft.Json.Converters;
44

@@ -7,8 +7,15 @@ namespace PuppeteerSharp.Input
77
[JsonConverter(typeof(StringEnumConverter))]
88
internal enum PointerType
99
{
10+
/// <summary>
11+
/// Mouse
12+
/// </summary>
1013
[EnumMember(Value = "mouse")]
1114
Mouse,
15+
16+
/// <summary>
17+
/// Pen
18+
/// </summary>
1219
[EnumMember(Value = "pen")]
1320
Pen,
1421
}

lib/PuppeteerSharp/Messaging/DispatchKeyEventType.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,21 @@ namespace PuppeteerSharp.Messaging
77
[JsonConverter(typeof(StringEnumConverter))]
88
internal enum DispatchKeyEventType
99
{
10+
/// <summary>
11+
/// Key down
12+
/// </summary>
1013
[EnumMember(Value = "keyDown")]
1114
KeyDown,
15+
16+
/// <summary>
17+
/// Raw key down
18+
/// </summary>
1219
[EnumMember(Value = "rawKeyDown")]
1320
RawKeyDown,
21+
22+
/// <summary>
23+
/// Key up
24+
/// </summary>
1425
[EnumMember(Value = "keyUp")]
1526
KeyUp,
1627
}

lib/PuppeteerSharp/Messaging/DragEventType.cs

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
using System.Runtime.Serialization;
1+
using System.Runtime.Serialization;
22
using Newtonsoft.Json;
33
using Newtonsoft.Json.Converters;
44

@@ -7,10 +7,21 @@ namespace PuppeteerSharp.Messaging
77
[JsonConverter(typeof(StringEnumConverter))]
88
internal enum DragEventType
99
{
10+
/// <summary>
11+
/// Drag event
12+
/// </summary>
1013
[EnumMember(Value = "dragEnter")]
1114
DragEnter,
15+
16+
/// <summary>
17+
/// Drag over
18+
/// </summary>
1219
[EnumMember(Value = "dragOver")]
1320
DragOver,
21+
22+
/// <summary>
23+
/// Drop
24+
/// </summary>
1425
[EnumMember(Value = "drop")]
1526
Drop,
1627
}

lib/PuppeteerSharp/Messaging/FileChooserAction.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,21 @@ namespace PuppeteerSharp.Messaging
77
[JsonConverter(typeof(StringEnumConverter))]
88
internal enum FileChooserAction
99
{
10+
/// <summary>
11+
/// Accept
12+
/// </summary>
1013
[EnumMember(Value = "accept")]
1114
Accept,
15+
16+
/// <summary>
17+
/// Fallback
18+
/// </summary>
1219
[EnumMember(Value = "fallback")]
1320
Fallback,
21+
22+
/// <summary>
23+
/// Cancel
24+
/// </summary>
1425
[EnumMember(Value = "cancel")]
1526
Cancel,
1627
}

lib/PuppeteerSharp/Messaging/MouseEventType.cs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,27 @@ namespace PuppeteerSharp.Messaging
77
[JsonConverter(typeof(StringEnumConverter))]
88
internal enum MouseEventType
99
{
10+
/// <summary>
11+
/// Mouse moved
12+
/// </summary>
1013
[EnumMember(Value = "mouseMoved")]
1114
MouseMoved,
15+
16+
/// <summary>
17+
/// Mouse clicked
18+
/// </summary>
1219
[EnumMember(Value = "mousePressed")]
1320
MousePressed,
21+
22+
/// <summary>
23+
/// Mouse click released
24+
/// </summary>
1425
[EnumMember(Value = "mouseReleased")]
1526
MouseReleased,
27+
28+
/// <summary>
29+
/// Mouse wheel
30+
/// </summary>
1631
[EnumMember(Value = "mouseWheel")]
1732
MouseWheel,
1833
}

lib/PuppeteerSharp/Messaging/PageFrameDetachedResponse.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,19 @@ namespace PuppeteerSharp.Messaging
66
[JsonConverter(typeof(FlexibleStringEnumConverter), Unknown)]
77
internal enum FrameDetachedReason
88
{
9+
/// <summary>
10+
/// Unknown
11+
/// </summary>
912
Unknown = -1,
13+
14+
/// <summary>
15+
/// Remove
16+
/// </summary>
1017
Remove,
18+
19+
/// <summary>
20+
/// Swap
21+
/// </summary>
1122
Swap,
1223
}
1324

0 commit comments

Comments
 (0)