From c9382c533bb8d54626f32279e861c66c29b4c6a1 Mon Sep 17 00:00:00 2001 From: Sam Harwell Date: Mon, 7 Jan 2019 08:13:04 -0600 Subject: [PATCH] Add placeholder documentation pages Fixes #22 --- .../Verifiers/DiagnosticVerifier.cs | 2 +- .../ApiDesign/DeclarePublicAPIAnalyzer.cs | 14 +++++++------- docs/RS0016.md | 3 +++ docs/RS0017.md | 3 +++ docs/RS0022.md | 3 +++ docs/RS0024.md | 3 +++ docs/RS0025.md | 3 +++ docs/RS0026.md | 3 +++ docs/RS0027.md | 3 +++ 9 files changed, 29 insertions(+), 8 deletions(-) create mode 100644 docs/RS0016.md create mode 100644 docs/RS0017.md create mode 100644 docs/RS0022.md create mode 100644 docs/RS0024.md create mode 100644 docs/RS0025.md create mode 100644 docs/RS0026.md create mode 100644 docs/RS0027.md diff --git a/PublicApiAnalyzer/PublicApiAnalyzer.Test/Verifiers/DiagnosticVerifier.cs b/PublicApiAnalyzer/PublicApiAnalyzer.Test/Verifiers/DiagnosticVerifier.cs index f40f66c..eadfaf0 100644 --- a/PublicApiAnalyzer/PublicApiAnalyzer.Test/Verifiers/DiagnosticVerifier.cs +++ b/PublicApiAnalyzer/PublicApiAnalyzer.Test/Verifiers/DiagnosticVerifier.cs @@ -49,7 +49,7 @@ public void TestHelpLink() continue; } - string expected = $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/documentation/{diagnostic.Id}.md"; + string expected = $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/docs/{diagnostic.Id}.md"; Assert.Equal(expected, diagnostic.HelpLinkUri); } } diff --git a/PublicApiAnalyzer/PublicApiAnalyzer/ApiDesign/DeclarePublicAPIAnalyzer.cs b/PublicApiAnalyzer/PublicApiAnalyzer/ApiDesign/DeclarePublicAPIAnalyzer.cs index ec6a984..7320969 100644 --- a/PublicApiAnalyzer/PublicApiAnalyzer/ApiDesign/DeclarePublicAPIAnalyzer.cs +++ b/PublicApiAnalyzer/PublicApiAnalyzer/ApiDesign/DeclarePublicAPIAnalyzer.cs @@ -35,7 +35,7 @@ internal sealed partial class DeclarePublicAPIAnalyzer : DiagnosticAnalyzer defaultSeverity: DiagnosticSeverity.Warning, isEnabledByDefault: AnalyzerConstants.EnabledByDefault, description: new LocalizableResourceString(nameof(RoslynDiagnosticsResources.DeclarePublicApiDescription), RoslynDiagnosticsResources.ResourceManager, typeof(RoslynDiagnosticsResources)), - helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/documentation/{RoslynDiagnosticIds.DeclarePublicApiRuleId}.md", + helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/docs/{RoslynDiagnosticIds.DeclarePublicApiRuleId}.md", customTags: new string[0]); internal static readonly DiagnosticDescriptor RemoveDeletedApiRule = new DiagnosticDescriptor( @@ -46,7 +46,7 @@ internal sealed partial class DeclarePublicAPIAnalyzer : DiagnosticAnalyzer defaultSeverity: DiagnosticSeverity.Warning, isEnabledByDefault: AnalyzerConstants.EnabledByDefault, description: new LocalizableResourceString(nameof(RoslynDiagnosticsResources.RemoveDeletedApiDescription), RoslynDiagnosticsResources.ResourceManager, typeof(RoslynDiagnosticsResources)), - helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/documentation/{RoslynDiagnosticIds.RemoveDeletedApiRuleId}.md", + helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/docs/{RoslynDiagnosticIds.RemoveDeletedApiRuleId}.md", customTags: new string[0]); internal static readonly DiagnosticDescriptor ExposedNoninstantiableType = new DiagnosticDescriptor( @@ -57,7 +57,7 @@ internal sealed partial class DeclarePublicAPIAnalyzer : DiagnosticAnalyzer defaultSeverity: DiagnosticSeverity.Warning, isEnabledByDefault: AnalyzerConstants.EnabledByDefault, description: new LocalizableResourceString(nameof(RoslynDiagnosticsResources.ExposedNoninstantiableTypeDescription), RoslynDiagnosticsResources.ResourceManager, typeof(RoslynDiagnosticsResources)), - helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/documentation/{RoslynDiagnosticIds.ExposedNoninstantiableTypeRuleId}.md", + helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/docs/{RoslynDiagnosticIds.ExposedNoninstantiableTypeRuleId}.md", customTags: new string[0]); internal static readonly DiagnosticDescriptor PublicApiFilesInvalid = new DiagnosticDescriptor( @@ -67,7 +67,7 @@ internal sealed partial class DeclarePublicAPIAnalyzer : DiagnosticAnalyzer category: AnalyzerCategory.ApiDesign, defaultSeverity: DiagnosticSeverity.Warning, isEnabledByDefault: AnalyzerConstants.EnabledByDefault, - helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/documentation/{RoslynDiagnosticIds.PublicApiFilesInvalid}.md", + helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/docs/{RoslynDiagnosticIds.PublicApiFilesInvalid}.md", customTags: new string[0]); internal static readonly DiagnosticDescriptor DuplicateSymbolInApiFiles = new DiagnosticDescriptor( @@ -77,7 +77,7 @@ internal sealed partial class DeclarePublicAPIAnalyzer : DiagnosticAnalyzer category: AnalyzerCategory.ApiDesign, defaultSeverity: DiagnosticSeverity.Warning, isEnabledByDefault: AnalyzerConstants.EnabledByDefault, - helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/documentation/{RoslynDiagnosticIds.DuplicatedSymbolInPublicApiFiles}.md", + helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/docs/{RoslynDiagnosticIds.DuplicatedSymbolInPublicApiFiles}.md", customTags: new string[0]); internal static readonly DiagnosticDescriptor AvoidMultipleOverloadsWithOptionalParameters = new DiagnosticDescriptor( @@ -87,7 +87,7 @@ internal sealed partial class DeclarePublicAPIAnalyzer : DiagnosticAnalyzer category: AnalyzerCategory.ApiDesign, defaultSeverity: DiagnosticSeverity.Warning, isEnabledByDefault: AnalyzerConstants.EnabledByDefault, - helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/documentation/{RoslynDiagnosticIds.AvoidMultipleOverloadsWithOptionalParameters}.md", + helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/docs/{RoslynDiagnosticIds.AvoidMultipleOverloadsWithOptionalParameters}.md", customTags: new string[0]); internal static readonly DiagnosticDescriptor OverloadWithOptionalParametersShouldHaveMostParameters = new DiagnosticDescriptor( @@ -97,7 +97,7 @@ internal sealed partial class DeclarePublicAPIAnalyzer : DiagnosticAnalyzer category: AnalyzerCategory.ApiDesign, defaultSeverity: DiagnosticSeverity.Warning, isEnabledByDefault: AnalyzerConstants.EnabledByDefault, - helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/documentation/{RoslynDiagnosticIds.OverloadWithOptionalParametersShouldHaveMostParameters}.md", + helpLinkUri: $"https://github.com/DotNetAnalyzers/PublicApiAnalyzer/blob/master/docs/{RoslynDiagnosticIds.OverloadWithOptionalParametersShouldHaveMostParameters}.md", customTags: new string[0]); internal static readonly SymbolDisplayFormat ShortSymbolNameFormat = diff --git a/docs/RS0016.md b/docs/RS0016.md new file mode 100644 index 0000000..98afbca --- /dev/null +++ b/docs/RS0016.md @@ -0,0 +1,3 @@ +# RS0016 + +🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26 diff --git a/docs/RS0017.md b/docs/RS0017.md new file mode 100644 index 0000000..2a30b68 --- /dev/null +++ b/docs/RS0017.md @@ -0,0 +1,3 @@ +# RS0017 + +🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26 diff --git a/docs/RS0022.md b/docs/RS0022.md new file mode 100644 index 0000000..c7f3c23 --- /dev/null +++ b/docs/RS0022.md @@ -0,0 +1,3 @@ +# RS0022 + +🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26 diff --git a/docs/RS0024.md b/docs/RS0024.md new file mode 100644 index 0000000..c29143c --- /dev/null +++ b/docs/RS0024.md @@ -0,0 +1,3 @@ +# RS0024 + +🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26 diff --git a/docs/RS0025.md b/docs/RS0025.md new file mode 100644 index 0000000..e2c2d74 --- /dev/null +++ b/docs/RS0025.md @@ -0,0 +1,3 @@ +# RS0025 + +🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26 diff --git a/docs/RS0026.md b/docs/RS0026.md new file mode 100644 index 0000000..090036e --- /dev/null +++ b/docs/RS0026.md @@ -0,0 +1,3 @@ +# RS0026 + +🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26 diff --git a/docs/RS0027.md b/docs/RS0027.md new file mode 100644 index 0000000..a96db94 --- /dev/null +++ b/docs/RS0027.md @@ -0,0 +1,3 @@ +# RS0027 + +🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26