Skip to content
Permalink
main
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time

Microsoft.CodeAnalysis.PublicApiAnalyzers

RS0016: Add public 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.

Item Value
Category ApiDesign
Enabled True
Severity Warning
CodeFix True

RS0017: Remove deleted types and members from the declared API

When removing a public type or member, put that entry in PublicAPI.Unshipped.txt with '*REMOVED*' prefix. This draws attention to API changes in the code reviews and source control history, and helps prevent breaking changes.

Item Value
Category ApiDesign
Enabled True
Severity Warning
CodeFix False

RS0022: Constructor make noninheritable base class inheritable

Constructor makes its noninheritable base class inheritable, thereby exposing its protected members

Item Value
Category ApiDesign
Enabled True
Severity Warning
CodeFix False

RS0024: The contents of the public API files are invalid

The contents of the public API files are invalid: {0}

Item Value
Category ApiDesign
Enabled True
Severity Warning
CodeFix False

RS0025: Do not duplicate symbols in public API files

The symbol '{0}' appears more than once in the public API files

Item Value
Category ApiDesign
Enabled True
Severity Warning
CodeFix False

RS0026: Do not add multiple public overloads with optional parameters

Symbol '{0}' violates the backcompat requirement: 'Do not add multiple overloads with optional parameters'. See '{1}' for details.

Item Value
Category ApiDesign
Enabled True
Severity Warning
CodeFix False

RS0027: Public API with optional parameter(s) should have the most parameters amongst its public overloads

Symbol '{0}' violates the backcompat requirement: 'Public API with optional parameter(s) should have the most parameters amongst its public overloads'. See '{1}' for details.

Item Value
Category ApiDesign
Enabled True
Severity Warning
CodeFix False

RS0036: Annotate nullability of public types and members in the declared API

All public types and members should be declared with nullability annotations in PublicAPI.txt. This draws attention to API nullability changes in the code reviews and source control history, and helps prevent breaking changes.

Item Value
Category ApiDesign
Enabled True
Severity Warning
CodeFix True

RS0037: 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).

Item Value
Category ApiDesign
Enabled True
Severity Warning
CodeFix True

RS0041: Public members should not use oblivious types

All public members should use either nullable or non-nullable reference types, but no oblivious reference types.

Item Value
Category ApiDesign
Enabled True
Severity Warning
CodeFix False

RS0048: Missing shipped or unshipped public API file

Public API file '{0}' is missing or not marked as an additional analyzer file

Item Value
Category ApiDesign
Enabled True
Severity Warning
CodeFix False

RS0050: Public API is marked as removed but it exists in source code

Symbol '{0}' is marked as removed but it isn't deleted in source code

Item Value
Category ApiDesign
Enabled True
Severity Warning
CodeFix False