DocFxIssuesAliases.

DocFxIssues(ICakeContext, DocFxIssuesSettings) Method

Summary

Gets an instance of a provider for warnings reported by DocFx using specified settings.
Assembly
Cake.Issues.DocFx.dll
Namespace
Cake.Issues.DocFx
Containing Type
DocFxIssuesAliases

Syntax

public static IIssueProvider DocFxIssues(this ICakeContext context, DocFxIssuesSettings settings)

Examples

Read warnings reported by DocFx:

 var settings =
         new DocFxIssuesSettings(@"c:\build\docfx.log");

     var issues =
         ReadIssues(
             DocFxIssues(settings),
             @"c:\repo");

Attributes

Type Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute

Parameters

Name Type Description
context ICakeContext The context.
settings DocFxIssuesSettings Settings for reading the DocFx log.

Return Value

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