Merge pull request #207 from Microsoft/dev/andarno/fix206

Add help links for analyzers

Author: AArnott

src/Microsoft.VisualStudio.Threading.Analyzers/Utils.cs

@@ -635,6 +635,11 @@ internal static void Deconstruct<T1, T2, T3, T4>(this Tuple<T1, T2, T3, T4> tupl
             item4 = tuple.Item4;
         }
 
+        internal static string GetHelpLink(string analyzerId)
+        {
+            return $"https://github.com/Microsoft/vs-threading/blob/master/doc/analyzers/{analyzerId}.md";
+        }
+
         private static CSharpSyntaxNode UpdateStatementsForAsyncMethod(CSharpSyntaxNode body, SemanticModel semanticModel, bool hasResultValue)
         {
             var blockBody = body as BlockSyntax;

src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD001UseSwitchToMainThreadAsyncAnalyzer.cs

@@ -20,6 +20,7 @@ public class VSTHRD001UseSwitchToMainThreadAsyncAnalyzer : DiagnosticAnalyzer
             id: Id,
             title: Strings.VSTHRD001_Title,
             messageFormat: Strings.VSTHRD001_MessageFormat,
+            helpLinkUri: Utils.GetHelpLink(Id),
             category: "Usage",
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: true);

src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD002UseJtfRunAnalyzer.cs

@@ -39,6 +39,7 @@ public class VSTHRD002UseJtfRunAnalyzer : DiagnosticAnalyzer
             id: Id,
             title: Strings.VSTHRD002_Title,
             messageFormat: Strings.VSTHRD002_MessageFormat,
+            helpLinkUri: Utils.GetHelpLink(Id),
             category: "Usage",
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: true);

src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD003UseJtfRunAsyncAnalyzer.cs

@@ -46,6 +46,7 @@ public class VSTHRD003UseJtfRunAsyncAnalyzer : DiagnosticAnalyzer
             id: Id,
             title: Strings.VSTHRD003_Title,
             messageFormat: Strings.VSTHRD003_MessageFormat,
+            helpLinkUri: Utils.GetHelpLink(Id),
             category: "Usage",
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: true);

src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD010VsServiceUsageAnalyzer.cs

@@ -45,12 +45,13 @@ public class VSTHRD010VsServiceUsageAnalyzer : DiagnosticAnalyzer
         public const string Id = "VSTHRD010";
 
         internal static readonly DiagnosticDescriptor Descriptor = new DiagnosticDescriptor(
-           id: Id,
-           title: Strings.VSTHRD010_Title,
-           messageFormat: Strings.VSTHRD010_MessageFormat,
-           category: "Usage",
-           defaultSeverity: DiagnosticSeverity.Warning,
-           isEnabledByDefault: true);
+            id: Id,
+            title: Strings.VSTHRD010_Title,
+            messageFormat: Strings.VSTHRD010_MessageFormat,
+            helpLinkUri: Utils.GetHelpLink(Id),
+            category: "Usage",
+            defaultSeverity: DiagnosticSeverity.Warning,
+            isEnabledByDefault: true);
 
         private static readonly IImmutableSet<string> KnownMethodsToSwitchToMainThread = ImmutableHashSet.Create(StringComparer.Ordinal,
             Types.JoinableTaskFactory.SwitchToMainThreadAsync,

src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD011LazyOfTaskAnalyzer.cs

@@ -20,6 +20,7 @@ public class VSTHRD011LazyOfTaskAnalyzer : DiagnosticAnalyzer
             id: Id,
             title: Strings.VSTHRD011_Title,
             messageFormat: Strings.VSTHRD011_MessageFormat,
+            helpLinkUri: Utils.GetHelpLink(Id),
             category: "Usage",
             defaultSeverity: DiagnosticSeverity.Error,
             isEnabledByDefault: true);

src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD100AsyncVoidMethodAnalyzer.cs

@@ -39,6 +39,7 @@ public class VSTHRD100AsyncVoidMethodAnalyzer : DiagnosticAnalyzer
             id: Id,
             title: Strings.VSTHRD100_Title,
             messageFormat: Strings.VSTHRD100_MessageFormat,
+            helpLinkUri: Utils.GetHelpLink(Id),
             category: "Usage",
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: true);

src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD101AsyncVoidLambdaAnalyzer.cs

@@ -50,6 +50,7 @@ public class VSTHRD101AsyncVoidLambdaAnalyzer : DiagnosticAnalyzer
             id: Id,
             title: Strings.VSTHRD101_Title,
             messageFormat: Strings.VSTHRD101_MessageFormat,
+            helpLinkUri: Utils.GetHelpLink(Id),
             category: "Usage",
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: true);

src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzer.cs

@@ -24,6 +24,7 @@ public class VSTHRD102AvoidJtfRunInNonPublicMembersAnalyzer : DiagnosticAnalyzer
             id: Id,
             title: Strings.VSTHRD102_Title,
             messageFormat: Strings.VSTHRD102_MessageFormat,
+            helpLinkUri: Utils.GetHelpLink(Id),
             category: "Usage",
             defaultSeverity: DiagnosticSeverity.Info,
             isEnabledByDefault: true);

src/Microsoft.VisualStudio.Threading.Analyzers/VSTHRD103UseAsyncOptionAnalyzer.cs

@@ -35,6 +35,7 @@ public class VSTHRD103UseAsyncOptionAnalyzer : DiagnosticAnalyzer
             id: Id,
             title: Strings.VSTHRD103_Title,
             messageFormat: Strings.VSTHRD103_MessageFormat,
+            helpLinkUri: Utils.GetHelpLink(Id),
             category: "Usage",
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: true);