Class DiagnosticDescriptor

Inheritance
object
DiagnosticDescriptor
Implements
Inherited Members
Namespace: Microsoft.CodeAnalysis
Assembly: Microsoft.CodeAnalysis.dll
Syntax
public sealed class DiagnosticDescriptor : IEquatable<DiagnosticDescriptor?>

Constructors

DiagnosticDescriptor(string, LocalizableString, LocalizableString, string, DiagnosticSeverity, bool, LocalizableString?, string?, params string[])

Declaration
public DiagnosticDescriptor(string id, LocalizableString title, LocalizableString messageFormat, string category, DiagnosticSeverity defaultSeverity, bool isEnabledByDefault, LocalizableString? description = null, string? helpLinkUri = null, params string[] customTags)
Parameters
Type Name Description
string id
LocalizableString title
LocalizableString messageFormat
string category
DiagnosticSeverity defaultSeverity
bool isEnabledByDefault
LocalizableString description
string helpLinkUri
string[] customTags

DiagnosticDescriptor(string, string, string, string, DiagnosticSeverity, bool, string?, string?, params string[])

Declaration
public DiagnosticDescriptor(string id, string title, string messageFormat, string category, DiagnosticSeverity defaultSeverity, bool isEnabledByDefault, string? description = null, string? helpLinkUri = null, params string[] customTags)
Parameters
Type Name Description
string id
string title
string messageFormat
string category
DiagnosticSeverity defaultSeverity
bool isEnabledByDefault
string description
string helpLinkUri
string[] customTags

Properties

Category

Declaration
public string Category { get; }
Property Value
Type Description
string

CustomTags

Declaration
public IEnumerable<string> CustomTags { get; }
Property Value
Type Description
IEnumerable<string>

DefaultSeverity

Declaration
public DiagnosticSeverity DefaultSeverity { get; }
Property Value
Type Description
DiagnosticSeverity

Description

Declaration
public LocalizableString Description { get; }
Property Value
Type Description
LocalizableString

HelpLinkUri

Declaration
public string HelpLinkUri { get; }
Property Value
Type Description
string

Id

Declaration
public string Id { get; }
Property Value
Type Description
string

IsEnabledByDefault

Declaration
public bool IsEnabledByDefault { get; }
Property Value
Type Description
bool

MessageFormat

Declaration
public LocalizableString MessageFormat { get; }
Property Value
Type Description
LocalizableString

Title

Declaration
public LocalizableString Title { get; }
Property Value
Type Description
LocalizableString

Methods

Equals(DiagnosticDescriptor?)

Declaration
public bool Equals(DiagnosticDescriptor? other)
Parameters
Type Name Description
DiagnosticDescriptor other
Returns
Type Description
bool

Equals(object?)

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj
Returns
Type Description
bool
Overrides

GetEffectiveSeverity(CompilationOptions)

Declaration
public ReportDiagnostic GetEffectiveSeverity(CompilationOptions compilationOptions)
Parameters
Type Name Description
CompilationOptions compilationOptions
Returns
Type Description
ReportDiagnostic

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
int
Overrides

Implements