CodeAnalysisIssue<T> Class

Summary

Base class for a code analysis issue.
Assembly
Cake.Prca.dll
Namespace
Cake.Prca.Issues
Interfaces
Base Types
graph TD Base0["CodeAnalysisIssue"]-->Type click Base0 "/Cake.Prca.Website/api/Cake.Prca.Issues/CodeAnalysisIssue" Base1["object"]-->Base0 Interface0["ICodeAnalysisIssue"]-.->Type click Interface0 "/Cake.Prca.Website/api/Cake.Prca.Issues/ICodeAnalysisIssue" Type["CodeAnalysisIssue<T>"] class Type type-node

Syntax

public class CodeAnalysisIssue<T> : CodeAnalysisIssue, ICodeAnalysisIssue 
    where T : ICodeAnalysisProvider

Type Parameters

Name Description
T Type of the issue provider which has raised the issue.

Constructors

Name Summary
CodeAnalysisIssue(string, int?, string, int, string) Initializes a new instance of the CodeAnalysisIssue<T> class.
CodeAnalysisIssue(string, int?, string, int, string, Uri) Initializes a new instance of the CodeAnalysisIssue<T> class.

Properties

Name Value Summary
AffectedFileRelativePath FilePath
Gets the path to the file affacted by the issue. The path is relative to the repository root. Can be null if issue is not related to a change in a file.
Inherited from CodeAnalysisIssue
Line Nullable<T>
Gets the line in the file where the issues has occurred. Nothing if the issue affects the whole file or an asssembly.
Inherited from CodeAnalysisIssue
Message string
Gets the message of the code analysis issue.
Inherited from CodeAnalysisIssue
Priority int
Gets the priority of the message used to filter out issues if there are more issues than should be posted. Issues with a lower priority are filtered if there are more issues to post than is allowed.
Inherited from CodeAnalysisIssue
ProviderType string
Gets the type of the issue provider.
Inherited from CodeAnalysisIssue
Rule string
Gets the rule of the code analysis issue.
Inherited from CodeAnalysisIssue
RuleUrl Uri
Gets the URL containing information about the failing rule. Can be null if the issue provider provides no URL.
Inherited from CodeAnalysisIssue

Extension Methods

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