Class ModuleAnalyzer
Base class for all ModuleAnalyzers
Inherited Members
Namespace: Unity.ProjectAuditor .Editor.Core
Assembly: Unity.ProjectAuditor.Editor.dll
Syntax
public class ModuleAnalyzer
Remarks
Inheriting directly from ModuleAnalyzer will not create an Analyzer that a Module will create or run. You should inherit from one of the following classes, all of which declare Analyze() methods:
Methods
Initialize(Action<Descriptor>)
Initializes the Analyzer
Declaration
public virtual void Initialize(Action<Descriptor> registerDescriptor)
Parameters
Type | Name | Description |
---|---|---|
Action<Descriptor> | registerDescriptor | An Action which the method can invoke to register an Issue Descriptor for later reporting |
Remarks
Modules and their associated Analyzers are Initialized during the process of constructing the ProjectAuditor object. The primary purpose of the Initialize method is to register Descriptors for any Issues which the Analyzer can add to the report. Descriptors must be registered before they can be used to create Issues. However, other initialization is allowed within this method if required - perhaps constructing and/or caching data structures to optimize the Analyze() methods, which may be called many times during analysis.