Skip to content

Add DocumentationAnalyzers to build #14336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
iSazonov merged 5 commits into from
Jun 25, 2021
Merged

Add DocumentationAnalyzers to build #14336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b04070d
Add DocumentationAnalyzers to build
xtqqczze Dec 6, 2020
ae6db46
Enable DOC104: UseSeeLangword
xtqqczze Dec 6, 2020
dc12f62
Add documentation links
xtqqczze Jun 22, 2021
20a3837
Demote `DOC104` to suggestion
xtqqczze Jun 22, 2021
21e0d1f
Merge branch 'master' into DocumentationAnalyzers
xtqqczze Jun 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions .globalconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1037,6 +1037,70 @@ dotnet_diagnostic.IL3001.severity = warning
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/il3002
dotnet_diagnostic.IL3002.severity = warning

# DOC100: PlaceTextInParagraphs
# https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC100.md
dotnet_diagnostic.DOC100.severity = none

# DOC101: UseChildBlocksConsistently
# https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC101.md
dotnet_diagnostic.DOC101.severity = none

# DOC102: UseChildBlocksConsistentlyAcrossElementsOfTheSameKind
# https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC102.md
dotnet_diagnostic.DOC102.severity = none

# DOC103: UseUnicodeCharacters
# https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC103.md
dotnet_diagnostic.DOC103.severity = none

# DOC104: UseSeeLangword
# https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC104.md
dotnet_diagnostic.DOC104.severity = suggestion

# DOC105: UseParamref
# https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC105.md
dotnet_diagnostic.DOC105.severity = none

# DOC106: UseTypeparamref
# https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC106.md
dotnet_diagnostic.DOC106.severity = none

# DOC107: UseSeeCref
# https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC107.md
dotnet_diagnostic.DOC107.severity = none

# DOC108: AvoidEmptyParagraphs
# https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC108.md
dotnet_diagnostic.DOC108.severity = none

# DOC200: UseXmlDocumentationSyntax
# https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC200.md
dotnet_diagnostic.DOC200.severity = none

# DOC201: ItemShouldHaveDescription
# https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC201.md
dotnet_diagnostic.DOC201.severity = none

# DOC202: UseSectionElementsCorrectly
# https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC202.md
dotnet_diagnostic.DOC202.severity = none

# DOC203: UseBlockElementsCorrectly
# https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC203.md
dotnet_diagnostic.DOC203.severity = none

# DOC204: UseInlineElementsCorrectly
# https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC204.md
dotnet_diagnostic.DOC204.severity = none

# DOC207: UseSeeLangwordCorrectly
# https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC207.md
dotnet_diagnostic.DOC207.severity = none

# DOC209: UseSeeHrefCorrectly
# https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC209.md
dotnet_diagnostic.DOC209.severity = none

# IDE0001: SimplifyNames
# https://docs.microsoft.com/dotnet/fundamentals/code-analysis/style-rules/ide0001
dotnet_diagnostic.IDE0001.severity = silent
Expand Down
1 change: 1 addition & 0 deletions Analyzers.props
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<Project>
<ItemGroup>
<PackageReference Include="DotNetAnalyzers.DocumentationAnalyzers" Version="1.0.0-beta.59" PrivateAssets="all" />
<PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.312" PrivateAssets="all" />
</ItemGroup>
</Project>