From b04070d5aa77bf5fe38146039cf8cf5d6bae0db0 Mon Sep 17 00:00:00 2001 From: xtqqczze Date: Sun, 6 Dec 2020 17:23:08 +0000 Subject: [PATCH 1/4] Add DocumentationAnalyzers to build Fix #14321. --- .globalconfig | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ Analyzers.props | 1 + 2 files changed, 49 insertions(+) diff --git a/.globalconfig b/.globalconfig index f0cc41c388e..ab56368e256 100644 --- a/.globalconfig +++ b/.globalconfig @@ -742,6 +742,54 @@ dotnet_diagnostic.IL3000.severity = warning # IL3001: Avoid using accessing Assembly file path when publishing as a single-file dotnet_diagnostic.IL3001.severity = warning +# DOC100: PlaceTextInParagraphs +dotnet_diagnostic.DOC100.severity = none + +# DOC101: UseChildBlocksConsistently +dotnet_diagnostic.DOC101.severity = none + +# DOC102: UseChildBlocksConsistentlyAcrossElementsOfTheSameKind +dotnet_diagnostic.DOC102.severity = none + +# DOC103: UseUnicodeCharacters +dotnet_diagnostic.DOC103.severity = none + +# DOC104: UseSeeLangword +dotnet_diagnostic.DOC104.severity = none + +# DOC105: UseParamref +dotnet_diagnostic.DOC105.severity = none + +# DOC106: UseTypeparamref +dotnet_diagnostic.DOC106.severity = none + +# DOC107: UseSeeCref +dotnet_diagnostic.DOC107.severity = none + +# DOC108: AvoidEmptyParagraphs +dotnet_diagnostic.DOC108.severity = none + +# DOC200: UseXmlDocumentationSyntax +dotnet_diagnostic.DOC200.severity = none + +# DOC201: ItemShouldHaveDescription +dotnet_diagnostic.DOC201.severity = none + +# DOC202: UseSectionElementsCorrectly +dotnet_diagnostic.DOC202.severity = none + +# DOC203: UseBlockElementsCorrectly +dotnet_diagnostic.DOC203.severity = none + +# DOC204: UseInlineElementsCorrectly +dotnet_diagnostic.DOC204.severity = none + +# DOC207: UseSeeLangwordCorrectly +dotnet_diagnostic.DOC207.severity = none + +# DOC209: UseSeeHrefCorrectly +dotnet_diagnostic.DOC209.severity = none + # IDE0001: SimplifyNames dotnet_diagnostic.IDE0001.severity = silent diff --git a/Analyzers.props b/Analyzers.props index 14b63bff789..4e6ed0381ff 100644 --- a/Analyzers.props +++ b/Analyzers.props @@ -1,5 +1,6 @@ + From ae6db4633c0892f0085ba73fb89c36bba0204459 Mon Sep 17 00:00:00 2001 From: xtqqczze Date: Sun, 6 Dec 2020 17:43:51 +0000 Subject: [PATCH 2/4] Enable DOC104: UseSeeLangword https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC104.md --- .globalconfig | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.globalconfig b/.globalconfig index ab56368e256..ae7a78a6ff3 100644 --- a/.globalconfig +++ b/.globalconfig @@ -755,7 +755,7 @@ dotnet_diagnostic.DOC102.severity = none dotnet_diagnostic.DOC103.severity = none # DOC104: UseSeeLangword -dotnet_diagnostic.DOC104.severity = none +dotnet_diagnostic.DOC104.severity = warning # DOC105: UseParamref dotnet_diagnostic.DOC105.severity = none From dc12f625e393b578b0aab520a9a961286112642f Mon Sep 17 00:00:00 2001 From: xtqqczze Date: Tue, 22 Jun 2021 18:07:58 +0100 Subject: [PATCH 3/4] Add documentation links --- .globalconfig | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/.globalconfig b/.globalconfig index ae7a78a6ff3..d144627d157 100644 --- a/.globalconfig +++ b/.globalconfig @@ -743,51 +743,67 @@ dotnet_diagnostic.IL3000.severity = warning dotnet_diagnostic.IL3001.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 = warning # 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 From 20a38370d7075ebf425697c59d053d7ae879b45f Mon Sep 17 00:00:00 2001 From: xtqqczze Date: Tue, 22 Jun 2021 19:00:17 +0100 Subject: [PATCH 4/4] Demote `DOC104` to suggestion --- .globalconfig | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.globalconfig b/.globalconfig index d144627d157..feb5d1a98d1 100644 --- a/.globalconfig +++ b/.globalconfig @@ -760,7 +760,7 @@ dotnet_diagnostic.DOC103.severity = none # DOC104: UseSeeLangword # https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC104.md -dotnet_diagnostic.DOC104.severity = warning +dotnet_diagnostic.DOC104.severity = suggestion # DOC105: UseParamref # https://github.com/DotNetAnalyzers/DocumentationAnalyzers/blob/master/docs/DOC105.md