Click or drag to resize

DiagnosticDescriptor Class



Provides a description about a Diagnostic
Inheritance Hierarchy
SystemObject
  Microsoft.CodeAnalysisDiagnosticDescriptor

Namespace:  Microsoft.CodeAnalysis
Assembly:  Microsoft.CodeAnalysis (in Microsoft.CodeAnalysis.dll) Version: 2.3.0-dev-56735-00. Commit Hash: <developer build>
Syntax
public sealed class DiagnosticDescriptor : IEquatable

The DiagnosticDescriptor type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyCategory
The category of the diagnostic (like Design, Naming etc.)
Public propertyCustomTags
Custom tags for the diagnostic.
Public propertyDefaultSeverity
The default severity of the diagnostic.
Public propertyDescription
An optional longer localizable description for the diagnostic.
Public propertyHelpLinkUri
An optional hyperlink that provides more detailed information regarding the diagnostic.
Public propertyId
An unique identifier for the diagnostic.
Public propertyIsEnabledByDefault
Returns true if the diagnostic is enabled by default.
Public propertyMessageFormat
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.
Public propertyTitle
A short localizable title describing the diagnostic.
Top
Methods
  NameDescription
Public methodEquals(Object)
Public methodEquals(DiagnosticDescriptor)
Public methodGetEffectiveSeverity
Gets the effective severity of diagnostics created based on this descriptor and the given CompilationOptions.
Public methodGetHashCode
Top
See Also