ShuriZma
/
BizHawk
mirror of https://github.com/TASEmulators/BizHawk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Mess w/ doc comment warnings

This commit is contained in:
YoshiRulz 2020-06-20 16:47:26 +10:00 committed by zeromus
parent dfe027cf8f
commit 43cc80f6a3
2 changed files with 23 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Common.ruleset
View File

@ -234,11 +234,6 @@
<Rule Id="CA5351" Action="Hidden" />
</Rules>
<Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers.SpecialRules">
<!-- XML comment analysis disabled -->
<Rule Id="SA0001" Action="Hidden" />
</Rules>
<Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers.SpacingRules">
<!-- Keywords should be spaced correctly -->
<Rule Id="SA1000" Action="Hidden" />
@ -497,6 +492,9 @@
<!-- Opening braces should not be followed by blank line -->
<Rule Id="SA1505" Action="Hidden" />
<!-- Element documentation headers should not be followed by blank line -->
<Rule Id="SA1506" Action="Hidden" />
<!-- Code should not contain multiple blank lines in a row -->
<Rule Id="SA1507" Action="Hidden" />
@ -538,12 +536,30 @@
</Rules>
<Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers.DocumentationRules">
<!-- Element documentation should have summary text -->
<Rule Id="SA1606" Action="Hidden" />
<!-- Property documentation should have value text -->
<Rule Id="SA1610" Action="Hidden" />
<!-- Element parameter documentation should match element parameters -->
<Rule Id="SA1612" Action="Hidden" />
<!-- Element parameter documentation should have text -->
<Rule Id="SA1614" Action="Hidden" />
<!-- Element return value documentation should have text -->
<Rule Id="SA1616" Action="Hidden" />
<!-- Void return value should not be documented -->
<Rule Id="SA1617" Action="Hidden" />
<!-- Property summary documentation should match accessors -->
<Rule Id="SA1623" Action="Hidden" />
<!-- Element documentation should not be copied and pasted -->
<Rule Id="SA1625" Action="Hidden" />
<!-- Single-line comments should not use documentation style slashes -->
<Rule Id="SA1626" Action="Hidden" />

3
src/MainSlnCommon.props
View File

@ -3,8 +3,9 @@
<PropertyGroup>
<AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
<CodeAnalysisRuleSet>$(ProjectDir)../../Common.ruleset</CodeAnalysisRuleSet>
<DocumentationFile>$(ProjectDir)bin/doc_comments.xml</DocumentationFile>
<MSBuildWarningsAsMessages>NU1702</MSBuildWarningsAsMessages>
<NoWarn>NU1701</NoWarn>
<NoWarn>CS1570;CS1572;CS1573;CS1574;CS1591;CS1734;NU1701</NoWarn>
<OutputPath>$(ProjectDir)../../output/dll</OutputPath>
</PropertyGroup>
<ItemGroup>