AnalysisContext
Base class for a context object passed by a Module to an Analyzer's Analyze() method.
Read time 1 minuteLast updated 7 days ago
Definition
- Type: Class
- Namespace: Unity.ProjectAuditor.Editor.Core
- Assembly: UnityEditor
public class AnalysisContext
Remarks
AnalysisContext provides information to the Analyze() method which is used to decide which issues to report. It also provides helper methods to build Issues or Insights.
Fields
Value | Description |
|---|---|
| Params | The AnalysisParams object that was passed to (or created by) the ProjectAuditor's Audit() method. |
Methods
Method | Description |
|---|---|
| CreateInsight | Create a ReportItemBuilder for an Insight: A ReportItem collected for informational purposes. |
| CreateIssue | Create a ReportItemBuilder for an Issue: a potential problem in the project, with an actionable recommendation to resolve it. |
| IsDescriptorEnabled | Checks whether a given Descriptor is enabled for the current analysis. |