Class DiagnosticParameterAttribute

Used to mark an integer field in an class that inherits from ModuleAnalyzer as being a Diagnostic Parameter.

Inheritance
object
Attribute
DiagnosticParameterAttribute
Implements
Inherited Members
Namespace: Unity.ProjectAuditor.Editor.Core
Assembly: Unity.ProjectAuditor.Editor.dll
Syntax
[AttributeUsage(AttributeTargets.Field)]
public class DiagnosticParameterAttribute : Attribute, _Attribute
Remarks

Diagnostic Parameters are used to define threshold values against which to compare other values when an Analyzer is deciding whether or not something constitutes a reportable issue. Whilst Analyzers are free to use hard-coded constants as threshold values, Diagnostic Parameters allow you to change values in Settings > Project Auditor as a project's requirements evolve, or to set different values for different target platforms.

Diagnostic Parameters and their default values are automatically registered in the DiagnosticParams object held by ProjectAuditorSettings, where their values can be customized if required. When ProjectAuditor initializes prior to running analysis, the values in the DiagnosticParams held by AnalysisParams are automatically cached back in their corresponding fields which can be used during analysis.

Constructors

DiagnosticParameterAttribute(string, string, string, int)

Constructor.

Declaration
public DiagnosticParameterAttribute(string name, string userFriendlyName, string tooltip, int defaultValue)
Parameters
Type Name Description
string name

The Diagnotic Parameter's name
string userFriendlyName

The Diagnostic Parameter's user friendly name for Project Settings.
string tooltip

The Diagnotic Parameter's tooltip text for project settings.
int defaultValue

A default value for the parameter

Properties

DefaultValue

The default value for this parameter.

Declaration
public int DefaultValue { get; }
Property Value
Type Description
int

Name

The Diagnostic Parameter's name. This name should uniquely identify this parameter within a project.

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

Tooltip

Text about this DiagnosticParameter to show as a tooltip in Project Settings.

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

UserFriendlyName

The Diagnostic Parameter's user friendly name as will be seen in Project Settings.

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

Implements