Skip to content

Commit c3350bc

Browse files
authored
Enable rule SA1600 (#2058)
* Enable rulee SA1600 * Revert sln changes. * Add stylecop.json
1 parent 732bcf6 commit c3350bc

File tree

5 files changed

+14
-1
lines changed

5 files changed

+14
-1
lines changed

lib/PuppeteerSharp.ruleset

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
<Rule Id="SA1624" Action="Error" /> <!-- Error SA1624: Because the property only contains a visible get accessor, the documentation summary text should begin with 'Gets'. (SA1624)-->
1212
<Rule Id="SA1028" Action="Error" /> <!-- Error SA1028: Code should not contain trailing whitespace (SA1028)-->
13-
<Rule Id="SA1600" Action="None" /> <!-- Error SA1600: Elements should be documented (SA1600)-->
13+
<Rule Id="SA1600" Action="Error" /> <!-- Error SA1600: Elements should be documented (SA1600)-->
1414
<Rule Id="SA1516" Action="Error" /> <!-- Error SA1516: Elements should be separated by blank line (SA1516)-->
1515
<Rule Id="SA1629" Action="Error" /> <!-- Error SA1629: Documentation text should end with a period (SA1629)-->
1616
<Rule Id="SA1514" Action="Error" /> <!-- Error SA1514: Element documentation header should be preceded by blank line (SA1514)-->

lib/PuppeteerSharp.sln

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
1919
..\Directory.Build.props = ..\Directory.Build.props
2020
PuppeteerSharp.ruleset = PuppeteerSharp.ruleset
2121
Common\SignAssembly.props = Common\SignAssembly.props
22+
stylecop.json = stylecop.json
2223
EndProjectSection
2324
EndProject
2425
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "PuppeteerSharp.Xunit", "PuppeteerSharp.Xunit\PuppeteerSharp.Xunit.csproj", "{EE53767C-D321-4BCF-B372-57949F38AB40}"

lib/PuppeteerSharp/Page.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,7 @@ private Page(
168168
/// <inheritdoc cref="CDPSession"/>
169169
public CDPSession Client { get; }
170170

171+
/// <inheritdoc cref="ICDPSession"/>
171172
ICDPSession IPage.Client => Client;
172173

173174
/// <inheritdoc/>

lib/PuppeteerSharp/PuppeteerSharp.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,7 @@
5757
<ItemGroup>
5858
<None Remove="System.Text.Encodings.Web" />
5959
</ItemGroup>
60+
<ItemGroup>
61+
<AdditionalFiles Include="..\stylecop.json" Link="stylecop.json" />
62+
</ItemGroup>
6063
</Project>

lib/stylecop.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json",
3+
"settings": {
4+
"documentationRules": {
5+
"documentInternalElements": false
6+
}
7+
}
8+
}

0 commit comments

Comments
 (0)