CodeAnalysisProvider Class

Summary

Base class for all code analysis provider implementations.
Assembly
Cake.Prca.dll
Namespace
Cake.Prca.Issues
Interfaces
Base Types
  • object
graph TD Base0["object"]-->Type Interface0["ICodeAnalysisProvider"]-.->Type click Interface0 "/Cake.Prca.Website/api/Cake.Prca.Issues/ICodeAnalysisProvider" Type["CodeAnalysisProvider"] class Type type-node

Syntax

public abstract class CodeAnalysisProvider : ICodeAnalysisProvider

Constructors

Name Summary
CodeAnalysisProvider(ICakeLog) Initializes a new instance of the CodeAnalysisProvider class.

Properties

Name Value Summary
Log ICakeLog
Gets the Cake log context.
PrcaSettings PrcaSettings
Gets general settings. Is set after Initialize(PrcaSettings) was called from the core addin.

Methods

Name Value Summary
Initialize(PrcaSettings) bool
Initializes the code analysis provider.
InternalReadIssues(PrcaCommentFormat) IEnumerable<T>
Gets all code analysis issues. Compared to ReadIssues(PrcaCommentFormat) it is safe to access PrcaSettings from this method.
ReadIssues(PrcaCommentFormat) IEnumerable<T>
Gets all code analysis issues.

Extension Methods

Name Value Summary
NotNull<CodeAnalysisProvider>(string) void
Throws an exception if the specified parameter's value is null.
GitHub