Merge pull request #2727 from sharwell/update-beta008

Update to StyleCop Analyzers 1.1.0-beta008

Author: vweijsters

StyleCop.Analyzers/Directory.Build.props

@@ -42,7 +42,7 @@
 
   <ItemGroup>
     <PackageReference Include="AsyncUsageAnalyzers" Version="1.0.0-alpha003" PrivateAssets="all" />
-    <PackageReference Include="StyleCop.Analyzers" Version="1.1.0-beta007" PrivateAssets="all" />
+    <PackageReference Include="StyleCop.Analyzers" Version="1.1.0-beta008" PrivateAssets="all" />
   </ItemGroup>
 
   <ItemGroup>

StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/OrderingRules/SA1206CodeFixProvider.cs

@@ -107,7 +107,7 @@ private static SyntaxTokenList FullySortModifiers(SyntaxTokenList modifiers)
         /// </summary>
         /// <param name="modifiers">All modifiers from the declaration.</param>
         /// <param name="modifierToFix">The modifier with diagnostics.</param>
-        /// <returns>A partially sorted modifier list (sorted up to <paramref name="modifierToFix"/>)</returns>
+        /// <returns>A partially sorted modifier list (sorted up to <paramref name="modifierToFix"/>).</returns>
         private static SyntaxTokenList PartiallySortModifiers(SyntaxTokenList modifiers, SyntaxToken modifierToFix)
         {
             var accessModifiers = modifiers.Where(modifier => GetModifierType(modifier) == ModifierType.Access);

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

@@ -18,11 +18,16 @@ internal sealed partial class UsingCodeFixProvider
     {
         /// <summary>
         /// Contains a map of the different regions of a source file.
-        /// Used source file regions are:
-        /// - conditional directives (#if, #else, #elif, #endif)
-        /// - pragma warning directives
-        /// - region directives
         /// </summary>
+        /// <remarks>
+        /// <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>
+        /// </list>
+        /// </remarks>
         private class SourceMap
         {
             private readonly TreeTextSpan regionRoot;
@@ -42,7 +47,7 @@ private SourceMap(TreeTextSpan conditionalRoot, TreeTextSpan regionRoot, TreeTex
             internal TreeTextSpan ConditionalRoot { get; }
 
             /// <summary>
-            /// Constructs the directive map for the given <paramref name="compilationUnit"/>
+            /// Constructs the directive map for the given <paramref name="compilationUnit"/>.
             /// </summary>
             /// <param name="compilationUnit">The compilation unit to scan for directive trivia.</param>
             /// <returns>A new <see cref="SourceMap"/> object containing the directive trivia information from the passed <paramref name="compilationUnit"/>.</returns>

StyleCop.Analyzers/StyleCop.Analyzers.Status.Generator/CodeFixStatus.cs

@@ -4,7 +4,7 @@
 namespace StyleCop.Analyzers.Status.Generator
 {
     /// <summary>
-    /// This enum is used to indicate whether or not a code fix is implemented
+    /// This enum is used to indicate whether or not a code fix is implemented.
     /// </summary>
     public enum CodeFixStatus
     {

StyleCop.Analyzers/StyleCop.Analyzers.Status.Generator/SolutionReader.cs

@@ -62,10 +62,10 @@ private SolutionReader()
         /// <summary>
         /// Creates a new instance of the <see cref="SolutionReader"/> class.
         /// </summary>
-        /// <param name="pathToSln">The path to the StyleCop.Analayzers sln</param>
-        /// <param name="analyzerProjectName">The project name of the analyzer project</param>
-        /// <param name="codeFixProjectName">The project name of the code fix project</param>
-        /// <returns>A <see cref="Task{SolutionReader}"/> representing the asynchronous operation</returns>
+        /// <param name="pathToSln">The path to the StyleCop.Analayzers solution.</param>
+        /// <param name="analyzerProjectName">The project name of the analyzer project.</param>
+        /// <param name="codeFixProjectName">The project name of the code fix project.</param>
+        /// <returns>A <see cref="Task{TResult}"/> representing the asynchronous operation.</returns>
         public static async Task<SolutionReader> CreateAsync(string pathToSln, string analyzerProjectName = "StyleCop.Analyzers", string codeFixProjectName = "StyleCop.Analyzers.CodeFixes")
         {
             SolutionReader reader = new SolutionReader();

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

@@ -7,7 +7,7 @@ namespace StyleCop.Analyzers.Status.Generator
     using Newtonsoft.Json.Converters;
 
     /// <summary>
-    /// Represents a diagnostic in the StyleCop.Analyzers project
+    /// Represents a diagnostic in the StyleCop.Analyzers project.
     /// </summary>
     public class StyleCopDiagnostic
     {
@@ -97,15 +97,15 @@ public class StyleCopDiagnostic
         /// Creates an instance of the <see cref="StyleCopDiagnostic"/> class
         /// that is populated with the data stored in <paramref name="value"/>.
         /// </summary>
-        /// <param name="value">A json representing a <see cref="StyleCopDiagnostic"/></param>
+        /// <param name="value">A JSON string representing a <see cref="StyleCopDiagnostic"/>.</param>
         /// <returns>A <see cref="StyleCopDiagnostic"/> that is populated with the data stored in <paramref name="value"/>.</returns>
         public static StyleCopDiagnostic FromJson(string value)
         {
             return JsonConvert.DeserializeObject<StyleCopDiagnostic>(value);
         }
 
         /// <summary>
-        /// Returns a string representing this diagnostic
+        /// Returns a string representing this diagnostic.
         /// </summary>
         /// <returns>
         /// The string contains the diagnostic id and the short name.
@@ -116,9 +116,9 @@ public override string ToString()
         }
 
         /// <summary>
-        /// Returns a json representation of this diagnostic
+        /// Returns a JSON representation of this diagnostic.
         /// </summary>
-        /// <returns>A json string representing this diagnostic</returns>
+        /// <returns>A JSON string representing this diagnostic.</returns>
         public string ToJson()
         {
             return JsonConvert.SerializeObject(this);

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/ReadabilityRules/SA1125CSharp7UnitTests.cs

@@ -15,7 +15,7 @@ public class SA1125CSharp7UnitTests : SA1125UnitTests
         /// <summary>
         /// This is a regression test for DotNetAnalyzers/StyleCopAnalyzers#386.
         /// <see href="https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/386">SA1125
-        /// UseShorthandForNullableTypes incorrectly reported in typeof()</see>
+        /// UseShorthandForNullableTypes incorrectly reported in typeof()</see>.
         /// </summary>
         /// <param name="longForm">The source code for the long form of a <c>cref</c> attribute referencing
         /// an instantiation of <see cref="Nullable{T}"/> in a <c>typeof</c> expression.</param>
@@ -117,7 +117,7 @@ void MethodName()
         /// <summary>
         /// This is a regression test for DotNetAnalyzers/StyleCopAnalyzers#637.
         /// <see href="https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/637">SA1125
-        /// UseShorthandForNullableTypes incorrectly reported in <c>nameof</c> expression</see>
+        /// UseShorthandForNullableTypes incorrectly reported in <c>nameof</c> expression</see>.
         /// </summary>
         /// <param name="form">The source code for the content of a <c>nameof</c> expression referencing
         /// <see cref="Nullable{T}"/>.</param>
@@ -145,7 +145,7 @@ class ClassName<T>
         /// <summary>
         /// This is a regression test for DotNetAnalyzers/StyleCopAnalyzers#636.
         /// <see href="https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/636">SA1125
-        /// UseShorthandForNullableTypes incorrectly reported for static access through Nullable&lt;int&gt;</see>
+        /// UseShorthandForNullableTypes incorrectly reported for static access through Nullable&lt;int&gt;</see>.
         /// </summary>
         /// <remarks>
         /// <para>This special case of instance access through <c>Nullable&lt;int&gt;</c> was mentioned in a
@@ -177,7 +177,7 @@ class ClassName<T>
         /// <summary>
         /// This is a regression test for DotNetAnalyzers/StyleCopAnalyzers#636.
         /// <see href="https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/636">SA1125
-        /// UseShorthandForNullableTypes incorrectly reported for static access through Nullable&lt;int&gt;</see>
+        /// UseShorthandForNullableTypes incorrectly reported for static access through Nullable&lt;int&gt;</see>.
         /// </summary>
         /// <param name="form">The source code for an instantiation of <see cref="Nullable{T}"/> which does not use the
         /// shorthand syntax.</param>

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/ReadabilityRules/SA1127CSharp7UnitTests.cs

@@ -38,12 +38,8 @@ void LocalFunction<T>()
             await this.VerifyCSharpFixAsync(testCode, fixedCode, cancellationToken: CancellationToken.None).ConfigureAwait(false);
         }
 
-        /// <summary>
-        /// This is a regression test for DotNetAnalyzers/StyleCopAnalyzers#1476:
-        /// https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/1476
-        /// </summary>
-        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
         [Fact]
+        [WorkItem(1476, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/1476")]
         public async Task TestViolationWithLocalFunctionDeclarationMultiLineParametersAsync()
         {
             var testCode = @"
@@ -74,12 +70,8 @@ void LocalFunction<T>(
             await this.VerifyCSharpFixAsync(testCode, fixedCode, cancellationToken: CancellationToken.None).ConfigureAwait(false);
         }
 
-        /// <summary>
-        /// This is a regression test for DotNetAnalyzers/StyleCopAnalyzers#1652:
-        /// https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/1652
-        /// </summary>
-        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
         [Fact]
+        [WorkItem(1652, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/1652")]
         public async Task TestViolationWithLocalFunctionDeclarationRegionDirectiveAsync()
         {
             var testCode = $@"

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/ReadabilityRules/SA1139CSharp7UnitTests.cs

@@ -123,8 +123,8 @@ public object Method()
         /// <summary>
         /// Verifies that redundant cast on literal with digit separators does not trigger diagnostic.
         /// </summary>
-        /// <param name="literal">A literal that is casted</param>
-        /// <param name="type">A type that literal is casted on</param>
+        /// <param name="literal">A literal that is casted.</param>
+        /// <param name="type">A type that literal is casted on.</param>
         /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
         [Theory]
         [InlineData("0_1", "int")]
@@ -163,7 +163,7 @@ public void Method()
         /// <summary>
         /// Verifies that other types of casts should not produces diagnostics.
         /// </summary>
-        /// <param name="correctCastExpression">A legal cast that should not trigger diagnostic</param>
+        /// <param name="correctCastExpression">A legal cast that should not trigger diagnostic.</param>
         /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
         [Theory]
         [InlineData("(long)~0_1")]
@@ -185,9 +185,9 @@ public void Method()
         /// <summary>
         /// Verifies that diagnostics is not produced when error CS0221 is reported.
         /// </summary>
-        /// <param name="type">A type that a literal is casted on</param>
-        /// <param name="castedLiteral">A literal that is casted</param>
-        /// <param name="literalValue">The value of the literal reported in the compiler error</param>
+        /// <param name="type">A type that a literal is casted on.</param>
+        /// <param name="castedLiteral">A literal that is casted.</param>
+        /// <param name="literalValue">The value of the literal reported in the compiler error.</param>
         /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
         [Theory]
         [InlineData("ulong", "-0_1", "-1")]
@@ -215,7 +215,7 @@ public void Method()
         /// <summary>
         /// Verifies that casts in unchecked environment do not get replaced with incorrect values.
         /// </summary>
-        /// <param name="castExpression">A cast which can be performed in unchecked environment</param>
+        /// <param name="castExpression">A cast which can be performed in unchecked environment.</param>
         /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
         [Theory]
         [InlineData("(ulong)-0_1L")]

StyleCop.Analyzers/StyleCop.Analyzers.Test/DocumentationRules/SA1623UnitTests.cs

@@ -154,10 +154,10 @@ private class PrivateTestClass
 
         /// <summary>
         /// Verifies that empty summary tag does not throw an exception.
-        /// Regression test for #1943
         /// </summary>
         /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
         [Fact]
+        [WorkItem(1943, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/1943")]
         public async Task EmptySummaryTagShouldNotThrowAnExceptionAsync()
         {
             var testCode = @"public class ClassName
@@ -233,11 +233,11 @@ public class TestClass
         }
 
         /// <summary>
-        /// Verifies that an empty tag summary is ignored (should be handled by SA1606)
-        /// This is a regression test for #2230
+        /// Verifies that an empty tag summary is ignored (should be handled by SA1606).
         /// </summary>
         /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
         [Fact]
+        [WorkItem(2230, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/2230")]
         public async Task VerifyEmptySummaryTagIsIgnoredAsync()
         {
             var testCode = @"