Skip to content
This repository has been archived by the owner on Apr 8, 2019. It is now read-only.

Add placeholder documentation pages #27

Merged
merged 1 commit into from
Jan 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand All @@ -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(
Expand All @@ -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(
Expand All @@ -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(
Expand All @@ -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(
Expand All @@ -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(
Expand All @@ -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 =
Expand Down
3 changes: 3 additions & 0 deletions docs/RS0016.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# RS0016

🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26
3 changes: 3 additions & 0 deletions docs/RS0017.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# RS0017

🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26
3 changes: 3 additions & 0 deletions docs/RS0022.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# RS0022

🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26
3 changes: 3 additions & 0 deletions docs/RS0024.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# RS0024

🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26
3 changes: 3 additions & 0 deletions docs/RS0025.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# RS0025

🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26
3 changes: 3 additions & 0 deletions docs/RS0026.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# RS0026

🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26
3 changes: 3 additions & 0 deletions docs/RS0027.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# RS0027

🚧 See https://github.com/DotNetAnalyzers/PublicApiAnalyzer/issues/26