Skip to content

Latest commit

 

History

History
13 lines (12 loc) · 3.94 KB

Microsoft.CodeAnalysis.PublicApiAnalyzers.md

File metadata and controls

13 lines (12 loc) · 3.94 KB
Raw
Rule ID Title Category Enabled Severity CodeFix Description
RS0016 Add public types and members to the declared API ApiDesign True Warning True 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.
RS0017 Remove deleted types and members from the declared API ApiDesign True Warning False When removing a public type or member the corresponding entry in PublicAPI.txt should also be removed. This draws attention to API changes in the code reviews and source control history, and helps prevent breaking changes.
RS0022 Constructor make noninheritable base class inheritable ApiDesign True Warning False Constructor makes its noninheritable base class inheritable, thereby exposing its protected members.
RS0024 The contents of the public API files are invalid ApiDesign True Warning False The contents of the public API files are invalid: {0}
RS0025 Do not duplicate symbols in public API files ApiDesign True Warning False The symbol '{0}' appears more than once in the public API files.
RS0026 Do not add multiple public overloads with optional parameters ApiDesign True Warning False Symbol '{0}' violates the backcompat requirement: 'Do not add multiple overloads with optional parameters'. See '{1}' for details.
RS0027 Public API with optional parameter(s) should have the most parameters amongst its public overloads. ApiDesign True Warning False 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.
RS0036 Annotate nullability of public types and members in the declared API ApiDesign True Warning True 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.
RS0037 Enable tracking of nullability of reference types in the declared API ApiDesign True Warning True 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).
RS0041 Public members should not use oblivious types ApiDesign True Warning False All public members should use either nullable or non-nullable reference types, but no oblivious reference types.