DocFxIssuesProviderAliases Class

Summary

Contains functionality related to importing warnings from DocFx to write them to pull requests.
Assembly
Cake.Prca.Issues.DocFx.dll
Namespace
Cake.Prca.Issues.DocFx
Base Types
  • object
graph TD Base0["object"]-->Type Type["DocFxIssuesProviderAliases"] class Type type-node

Syntax

public static class DocFxIssuesProviderAliases

Attributes

Type Description
CakeAliasCategoryAttribute

Methods

Name Value Summary
DocFxIssues(ICakeContext, DocFxIssuesSettings) ICodeAnalysisProvider
Gets an instance of a provider for warnings reported by DocFx using specified settings.
static
DocFxIssuesFromContent(ICakeContext, string) ICodeAnalysisProvider
Gets an instance of a provider for warnings reported by DocFx using log file content for a DocFx project in the repository root.
static
DocFxIssuesFromContent(ICakeContext, string, DirectoryPath) ICodeAnalysisProvider
Gets an instance of a provider for warnings reported by DocFx using log file content.
static
DocFxIssuesFromFilePath(ICakeContext, FilePath) ICodeAnalysisProvider
Gets an instance of a provider for warnings reported by DocFx using a log file from disk for a DocFx project in the repository root.
static
DocFxIssuesFromFilePath(ICakeContext, FilePath, DirectoryPath) ICodeAnalysisProvider
Gets an instance of a provider for warnings reported by DocFx using a log file from disk.
static
GitHub