DiagnosticDescriptor Class

Definition

Namespace:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Package:

Microsoft.CodeAnalysis.Common v4.13.0

Source:

DiagnosticDescriptor.cs

Provides a description about a Diagnostic

C#

public sealed class DiagnosticDescriptor : IEquatable<Microsoft.CodeAnalysis.DiagnosticDescriptor>

Inheritance

Object

DiagnosticDescriptor

Implements

IEquatable<DiagnosticDescriptor>

Constructors

DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[])	Create a DiagnosticDescriptor, which provides description about a Diagnostic.
DiagnosticDescriptor(String, String, String, String, DiagnosticSeverity, Boolean, String, String, String[])	Create a DiagnosticDescriptor, which provides description about a Diagnostic. NOTE: For localizable title, description and/or messageFormat, use constructor overload DiagnosticDescriptor(String, LocalizableString, LocalizableString, String, DiagnosticSeverity, Boolean, LocalizableString, String, String[]).

Properties

Category	The category of the diagnostic (like Design, Naming etc.)
CustomTags	Custom tags for the diagnostic.
DefaultSeverity	The default severity of the diagnostic.
Description	An optional longer localizable description for the diagnostic.
HelpLinkUri	An optional hyperlink that provides more detailed information regarding the diagnostic.
Id	An unique identifier for the diagnostic.
IsEnabledByDefault	Returns true if the diagnostic is enabled by default.
MessageFormat	A localizable format message string, which can be passed as the first argument to Format(String, Object[]) when creating the diagnostic message with this descriptor.
Title	A short localizable title describing the diagnostic.

Methods

Equals(DiagnosticDescriptor)
Equals(Object)
GetEffectiveSeverity(CompilationOptions)	Gets the effective severity of diagnostics created based on this descriptor and the given CompilationOptions.
GetHashCode()

Applies to