CodeAnalysisIssue Class

Summary

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

Syntax

public class CodeAnalysisIssue : ICodeAnalysisIssue

Constructors

Name Summary
CodeAnalysisIssue(string, int?, string, int, string, string) Initializes a new instance of the CodeAnalysisIssue class.
CodeAnalysisIssue(string, int?, string, int, string, Uri, string) Initializes a new instance of the CodeAnalysisIssue 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.
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.
Message string
Gets the message of the code analysis issue.
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.
ProviderType string
Gets the type of the issue provider.
Rule string
Gets the rule of the code analysis issue.
RuleUrl Uri
Gets the URL containing information about the failing rule. Can be null if the issue provider provides no URL.

Extension Methods

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