DocFxIssuesProviderAliases.

DocFxIssues(ICakeContext, DocFxIssuesSettings) Method

Summary

Gets an instance of a provider for warnings reported by DocFx using specified settings.

Syntax

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

Examples

Report warnings reported by DocFx to a TFS pull request:

 var repoRoot = new DirectoryPath("c:\repo");
     var settings =
         new DocFxIssuesSettings("C:\build\docfx.log");

     ReportIssuesToPullRequest(
         DocFxIssues(settings),
         TfsPullRequests(
             new Uri("http://myserver:8080/tfs/defaultcollection/myproject/_git/myrepository"),
             "refs/heads/feature/myfeature",
             TfsAuthenticationNtlm()),
         repoRoot);

Attributes

Type Description
CakeAliasCategoryAttribute
CakeMethodAliasAttribute

Parameters

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

Return Value

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