Class Descriptor

Descriptor defines the problem and a possible recommendation

Inheritance

object

Descriptor

Implements

IEquatable<Descriptor>

Inherited Members

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace: Unity.ProjectAuditor.Editor.Diagnostic

Assembly: solution.dll

Syntax

[Serializable]
public sealed class Descriptor : IEquatable<Descriptor>

Constructors

Name	Description
Descriptor(string, string, string[], string, string)	Initializes and returns an instance of Descriptor
Descriptor(string, string, Area, string, string)	Initializes and returns an instance of Descriptor
Descriptor(string, string, Area[], string, string)	Initializes and returns an instance of Descriptor

Fields

Name	Description
areas	Affected areas
defaultSeverity	Default severity of the diagnostic
description	Description of the diagnostic
documentationUrl	Url to documentation
fixer	Optional Auto-fixer
id	An unique identifier for the diagnostic
maximumVersion	Maximum Unity version this diagnostic applies to. If not specified, the diagnostic applies to all versions
messageFormat	Message used to describe a specific instance of the diagnostic
method	Name of the method of a known code API issue
minimumVersion	Minimum Unity version this diagnostic applies to. If not specified, the diagnostic applies to all versions
platforms	Affected platforms. If null, the diagnostic applies to all platforms
solution	Recommendation to fix the diagnostic
title	Diagnostic title
type	Name of the type (namespace and class/struct) of a known code API issue
value	The evaluated value of a know code API issue

Methods

Name	Description
Equals(object)	Returns true if the Descriptor is equal to a given object, false otherwise.
Equals(Descriptor)	Returns true if the Descriptor is equal to a given Descriptor, false otherwise.
GetHashCode()	Returns a hash code for the Descriptor.
IsValid()	Returns whether the Descriptor has a valid Issue ID