Version: Unity 6.4 Alpha (6000.4)
LanguageEnglish
  • C#

Descriptor

class in Unity.ProjectAuditor.Editor

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Descriptor defines a potential problem and a recommended course of action.

Properties

Property Description
Areas Affected areas
DefaultSeverity Default Severity of the issue.
Description Description of the issue.
DocumentationUrl URL to documentation.
Fixer Optional Auto-Fixer
Id An unique identifier for the issue. IDs must have exactly 3 upper case characters, followed by 4 digits.
IsEnabledByDefault Returns true if the issue is enabled by default.
MaximumVersion Maximum Unity version this issue applies to. If not specified, the issue applies to all versions.
MessageFormat Message used to describe a specific instance of the issue.
Method Name of the method of a known code API issue.
MinimumVersion Minimum Unity version this issue applies to. If not specified, the issue applies to all versions.
Platforms Affected platforms. If null, the issue applies to all platforms.
Recommendation Recommendation to fix the issue.
Title Issue 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.

Constructors

Constructor Description
Descriptor Initializes and returns an instance of Descriptor.

Public Methods

Method Description
EqualsReturns true if the Descriptor is equal to a given Descriptor, false otherwise.
GetHashCodeReturns the hash code for the Descriptor's Issue ID.