DocFxIssuesAliases Class

Summary

Contains functionality related to read warnings from DocFx log files.
Assembly
Cake.Issues.DocFx.dll
Namespace
Cake.Issues.DocFx
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["DocFxIssuesAliases"] class Type type-node

Syntax

public static class DocFxIssuesAliases

Attributes

Type Description
CakeAliasCategoryAttribute

Methods

Name Value Summary
DocFxIssues(ICakeContext, DocFxIssuesSettings) IIssueProvider
Gets an instance of a provider for warnings reported by DocFx using specified settings.
static
DocFxIssuesFromContent(ICakeContext, string) IIssueProvider
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) IIssueProvider
Gets an instance of a provider for warnings reported by DocFx using log file content.
static
DocFxIssuesFromFilePath(ICakeContext, FilePath) IIssueProvider
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) IIssueProvider
Gets an instance of a provider for warnings reported by DocFx using a log file from disk.
static
DocFxIssuesProviderTypeName(ICakeContext) string
Gets the name of the DocFx issue provider. This name can be used to identify issues based on the ProviderType property.
static