DocFxIssuesProviderAliases.

DocFxIssuesFromFilePath(ICakeContext, FilePath, DirectoryPath) Method

Summary

Gets an instance of a provider for warnings reported by DocFx using a log file from disk.
Assembly
Cake.Prca.Issues.DocFx.dll
Namespace
Cake.Prca.Issues.DocFx
Containing Type
DocFxIssuesProviderAliases

Syntax

public static ICodeAnalysisProvider DocFxIssuesFromFilePath(this ICakeContext context, FilePath logFilePath, DirectoryPath docRootPath)

Examples

Report warnings reported by DocFx to a TFS pull request:

var repoRoot = new DirectoryPath("c:\repo");
    ReportIssuesToPullRequest(
        DocFxIssuesFromFilePath(
            "C:\build\docfx.log",
            "C:\build\doc"),
        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.
logFilePath FilePath Path to the the DocFx log file.
docRootPath DirectoryPath Path to the root directory of the DocFx project. Either the full path or the path relative to the repository root.

Return Value

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