Install DotNetAnalyzers.DocumentationAnalyzers and fix diagnostics

Author: sharwell

StyleCop.Analyzers/Directory.Build.props

@@ -42,6 +42,7 @@
 
   <ItemGroup>
     <PackageReference Include="AsyncUsageAnalyzers" Version="1.0.0-alpha003" PrivateAssets="all" />
+    <PackageReference Include="DotNetAnalyzers.DocumentationAnalyzers" Version="1.0.0-beta.46" PrivateAssets="all" />
     <PackageReference Include="StyleCop.Analyzers" Version="1.1.0-beta009" PrivateAssets="all" />
   </ItemGroup>
 

StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/Helpers/CustomFixAllProviders.cs

@@ -19,9 +19,9 @@ internal static class CustomFixAllProviders
         /// <see cref="FixAllScope.Document"/>, <see cref="FixAllScope.Project"/> and <see cref="FixAllScope.Solution"/>.
         /// </summary>
         /// <remarks>
-        /// The batch fix all provider only batches operations (i.e. <see cref="CodeActionOperation"/>) of type
+        /// <para>The batch fix all provider only batches operations (i.e. <see cref="CodeActionOperation"/>) of type
         /// <see cref="ApplyChangesOperation"/> present within the individual diagnostic fixes. Other types of
-        /// operations present within these fixes are ignored.
+        /// operations present within these fixes are ignored.</para>
         /// </remarks>
         /// <value>
         /// The default batch fix all provider.

StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/OrderingRules/UsingCodeFixProvider.SourceMap.cs

@@ -23,9 +23,9 @@ internal sealed partial class UsingCodeFixProvider
         /// <para>Used source file regions are:</para>
         ///
         /// <list type="bullet">
-        /// <item>conditional directives (#if, #else, #elif, #endif)</item>
-        /// <item>pragma warning directives</item>
-        /// <item>region directives</item>
+        /// <item><description>conditional directives (#if, #else, #elif, #endif)</description></item>
+        /// <item><description>pragma warning directives</description></item>
+        /// <item><description>region directives</description></item>
         /// </list>
         /// </remarks>
         private class SourceMap

StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/ReadabilityRules/SA1133CodeFixProvider.cs

@@ -20,8 +20,8 @@ namespace StyleCop.Analyzers.ReadabilityRules
     /// Implements a code fix for <see cref="SA1133DoNotCombineAttributes"/>.
     /// </summary>
     /// <remarks>
-    /// The SA1133 code fix adds the new lines to make sure that it doesn't immediately introduces a SA1134 after code fixing,
-    /// but it will not / should not attempt to fix any preexisting SA1134 cases.
+    /// <para>The SA1133 code fix adds the new lines to make sure that it doesn't immediately introduces a SA1134 after
+    /// code fixing, but it will not / should not attempt to fix any preexisting SA1134 cases.</para>
     /// </remarks>
     [ExportCodeFixProvider(LanguageNames.CSharp, Name = nameof(SA1133CodeFixProvider))]
     [Shared]

StyleCop.Analyzers/StyleCop.Analyzers.Status.Generator/StyleCopDiagnostic.cs

@@ -42,10 +42,10 @@ public class StyleCopDiagnostic
         /// </summary>
         /// <value>
         /// <list type="bullet">
-        /// <item>DisabledNoTests</item>
-        /// <item>DisabledAlternative</item>
-        /// <item>EnabledByDefault</item>
-        /// <item>DisabledByDefault</item>
+        /// <item><description>DisabledNoTests</description></item>
+        /// <item><description>DisabledAlternative</description></item>
+        /// <item><description>EnabledByDefault</description></item>
+        /// <item><description>DisabledByDefault</description></item>
         /// </list>
         /// </value>
         public string Status { get; set; }

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/LayoutRules/SA1500CSharp7UnitTests.cs

@@ -19,7 +19,8 @@ public class SA1500CSharp7UnitTests : SA1500UnitTests
         /// Verifies that no diagnostics are reported for the valid local functions defined in this test.
         /// </summary>
         /// <remarks>
-        /// These are valid for SA1500 only, some will report other diagnostics from the layout (SA15xx) series.
+        /// <para>These are valid for SA1500 only, some will report other diagnostics from the layout (SA15xx)
+        /// series.</para>
         /// </remarks>
         /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
         [Fact]

StyleCop.Analyzers/StyleCop.Analyzers.Test/Helpers/UseCultureAttribute.cs

@@ -15,10 +15,10 @@ namespace StyleCop.Analyzers.Test.Helpers
     /// <see cref="CultureInfo.CurrentUICulture" /> with another culture.
     /// </summary>
     /// <remarks>
-    /// This code was adapted from
+    /// <para>This code was adapted from
     /// https://github.com/xunit/samples.xunit/blob/885edfc/UseCulture/UseCultureAttribute.cs.
     /// The original code is (c) 2014 Outercurve Foundation and licensed under the Apache License,
-    /// Version 2.0.
+    /// Version 2.0.</para>
     /// </remarks>
     [AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
     public class UseCultureAttribute : BeforeAfterTestAttribute

StyleCop.Analyzers/StyleCop.Analyzers.Test/LayoutRules/SA1500/SA1500UnitTests.ArrayInitializers.cs

@@ -22,7 +22,7 @@ public partial class SA1500UnitTests
         /// Verifies that no diagnostics are reported for the valid array initializers defined in this test.
         /// </summary>
         /// <remarks>
-        /// These are valid for SA1500 only, some will report other diagnostics.
+        /// <para>These are valid for SA1500 only, some will report other diagnostics.</para>
         /// </remarks>
         /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
         [Fact]

StyleCop.Analyzers/StyleCop.Analyzers.Test/LayoutRules/SA1500/SA1500UnitTests.Blocks.cs

@@ -22,7 +22,8 @@ public partial class SA1500UnitTests
         /// Verifies that no diagnostics are reported for the valid block defined in this test.
         /// </summary>
         /// <remarks>
-        /// These are valid for SA1500 only, some will report other diagnostics from the layout (SA15xx) series.
+        /// <para>These are valid for SA1500 only, some will report other diagnostics from the layout (SA15xx)
+        /// series.</para>
         /// </remarks>
         /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
         [Fact]

StyleCop.Analyzers/StyleCop.Analyzers.Test/LayoutRules/SA1500/SA1500UnitTests.Classes.cs

@@ -22,7 +22,8 @@ public partial class SA1500UnitTests
         /// Verifies that no diagnostics are reported for the valid classes defined in this test.
         /// </summary>
         /// <remarks>
-        /// These are valid for SA1500 only, some will report other diagnostics from the layout (SA15xx) series.
+        /// <para>These are valid for SA1500 only, some will report other diagnostics from the layout (SA15xx)
+        /// series.</para>
         /// </remarks>
         /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
         [Fact]
@@ -54,7 +55,7 @@ public class ValidClass5
         /// Verifies diagnostics and codefixes for all invalid class definitions.
         /// </summary>
         /// <remarks>
-        /// These will normally also report SA1401, but not in the unit test.
+        /// <para>These will normally also report SA1401, but not in the unit test.</para>
         /// </remarks>
         /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
         [Fact]