DocFxIssuesAliases.

DocFxIssuesFromFilePath(ICakeContext, FilePath) Method

Summary

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.
Assembly
Cake.Issues.DocFx.dll
Namespace
Cake.Issues.DocFx
Containing Type
DocFxIssuesAliases

Syntax

public static IIssueProvider DocFxIssuesFromFilePath(this ICakeContext context, FilePath logFilePath)

Examples

Read warnings reported by DocFx:

var issues =
        ReadIssues(
            DocFxIssuesFromFilePath(@"c:\build\docfx.log"),
            @"c:\repo");

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute

Parameters

Name Type Description
context ICakeContext The context.
logFilePath FilePath Path to the DocFx log file.

Return Value

Type Description
IIssueProvider Instance of a provider for warnings reported by DocFx.
GitHub