diff --git a/src/NetAnalyzers/RulesMissingDocumentation.md b/src/NetAnalyzers/RulesMissingDocumentation.md index 339438ea6d..259e0c77c6 100644 --- a/src/NetAnalyzers/RulesMissingDocumentation.md +++ b/src/NetAnalyzers/RulesMissingDocumentation.md @@ -8,8 +8,5 @@ CA1510 | | Use ArgumentException throw helper | CA1512 | | Use ArgumentOutOfRangeException throw helper | CA1513 | | Use ObjectDisposedException throw helper | -CA1852 | | Seal internal types | -CA1853 | | Unnecessary call to 'Dictionary.ContainsKey(key)' | -CA1855 | | Prefer 'Clear' over 'Fill' | CA1856 | | Incorrect usage of ConstantExpected attribute | CA1857 | | A constant is expected for the parameter | diff --git a/src/PublicApiAnalyzers/Core/Analyzers/DeclarePublicApiAnalyzer_Diagnostics.cs b/src/PublicApiAnalyzers/Core/Analyzers/DeclarePublicApiAnalyzer_Diagnostics.cs index f0d86090e9..0c90b62b6e 100644 --- a/src/PublicApiAnalyzers/Core/Analyzers/DeclarePublicApiAnalyzer_Diagnostics.cs +++ b/src/PublicApiAnalyzers/Core/Analyzers/DeclarePublicApiAnalyzer_Diagnostics.cs @@ -52,7 +52,7 @@ public partial class DeclarePublicApiAnalyzer category: "ApiDesign", defaultSeverity: DiagnosticSeverity.Warning, isEnabledByDefault: false, - description: CreateLocalizableResourceString(nameof(DeclarePublicApiDescription)), + description: CreateLocalizableResourceString(nameof(DeclareInternalApiDescription)), helpLinkUri: "https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md", customTags: WellKnownDiagnosticTagsExtensions.Telemetry); @@ -270,7 +270,7 @@ public partial class DeclarePublicApiAnalyzer category: "ApiDesign", defaultSeverity: DiagnosticSeverity.Warning, isEnabledByDefault: false, - description: CreateLocalizableResourceString(nameof(ShouldAnnotatePublicApiFilesDescription)), + description: CreateLocalizableResourceString(nameof(ShouldAnnotateInternalApiFilesDescription)), helpLinkUri: "https://github.com/dotnet/roslyn-analyzers/blob/main/src/InternalApiAnalyzers/InternalApiAnalyzers.Help.md", customTags: WellKnownDiagnosticTagsExtensions.Telemetry); diff --git a/src/PublicApiAnalyzers/Microsoft.CodeAnalysis.PublicApiAnalyzers.md b/src/PublicApiAnalyzers/Microsoft.CodeAnalysis.PublicApiAnalyzers.md index efe78e764e..c6ab8a2de6 100644 --- a/src/PublicApiAnalyzers/Microsoft.CodeAnalysis.PublicApiAnalyzers.md +++ b/src/PublicApiAnalyzers/Microsoft.CodeAnalysis.PublicApiAnalyzers.md @@ -146,7 +146,7 @@ Symbol '{0}' is marked as removed but it isn't deleted in source code ## [RS0051](https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md): Add internal types and members to the declared API -All public types and members should be declared in PublicAPI.txt. This draws attention to API changes in the code reviews and source control history, and helps prevent breaking changes. +All internal types and members should be declared in InternalAPI.txt. This draws attention to API changes in the code reviews and source control history, and helps prevent breaking changes. |Item|Value| |-|-| @@ -206,7 +206,7 @@ All internal types and members should be declared with nullability annotations i ## [RS0056](https://github.com/dotnet/roslyn-analyzers/blob/main/src/InternalApiAnalyzers/InternalApiAnalyzers.Help.md): Enable tracking of nullability of reference types in the declared API -PublicAPI.txt files should have `#nullable enable` to track nullability information, or this diagnostic should be suppressed. With nullability enabled, PublicAPI.txt records which types are nullable (suffix `?` on type) or non-nullable (suffix `!`). It also tracks any API that is still using an oblivious reference type (prefix `~` on line). +InternalAPI.txt files should have `#nullable enable` to track nullability information, or this diagnostic should be suppressed. With nullability enabled, InternalAPI.txt records which types are nullable (suffix `?` on type) or non-nullable (suffix `!`). It also tracks any API that is still using an oblivious reference type (prefix `~` on line). |Item|Value| |-|-| diff --git a/src/PublicApiAnalyzers/Microsoft.CodeAnalysis.PublicApiAnalyzers.sarif b/src/PublicApiAnalyzers/Microsoft.CodeAnalysis.PublicApiAnalyzers.sarif index 04ce81d1c6..9da068fc4f 100644 --- a/src/PublicApiAnalyzers/Microsoft.CodeAnalysis.PublicApiAnalyzers.sarif +++ b/src/PublicApiAnalyzers/Microsoft.CodeAnalysis.PublicApiAnalyzers.sarif @@ -245,7 +245,7 @@ "RS0051": { "id": "RS0051", "shortDescription": "Add internal types and members to the declared API", - "fullDescription": "All public types and members should be declared in PublicAPI.txt. This draws attention to API changes in the code reviews and source control history, and helps prevent breaking changes.", + "fullDescription": "All internal types and members should be declared in InternalAPI.txt. This draws attention to API changes in the code reviews and source control history, and helps prevent breaking changes.", "defaultLevel": "warning", "helpUri": "https://github.com/dotnet/roslyn-analyzers/blob/main/src/PublicApiAnalyzers/PublicApiAnalyzers.Help.md", "properties": { @@ -343,7 +343,7 @@ "RS0056": { "id": "RS0056", "shortDescription": "Enable tracking of nullability of reference types in the declared API", - "fullDescription": "PublicAPI.txt files should have `#nullable enable` to track nullability information, or this diagnostic should be suppressed. With nullability enabled, PublicAPI.txt records which types are nullable (suffix `?` on type) or non-nullable (suffix `!`). It also tracks any API that is still using an oblivious reference type (prefix `~` on line).", + "fullDescription": "InternalAPI.txt files should have `#nullable enable` to track nullability information, or this diagnostic should be suppressed. With nullability enabled, InternalAPI.txt records which types are nullable (suffix `?` on type) or non-nullable (suffix `!`). It also tracks any API that is still using an oblivious reference type (prefix `~` on line).", "defaultLevel": "warning", "helpUri": "https://github.com/dotnet/roslyn-analyzers/blob/main/src/InternalApiAnalyzers/InternalApiAnalyzers.Help.md", "properties": {