DocFxIssuesProviderAliases.

DocFxIssuesFromContent(ICakeContext, string) Method

Summary

Gets an instance of a provider for warnings reported by DocFx using log file content for a DocFx project in the repository root.
Assembly
Cake.Prca.Issues.DocFx.dll
Namespace
Cake.Prca.Issues.DocFx
Containing Type
DocFxIssuesProviderAliases

Syntax

public static ICodeAnalysisProvider DocFxIssuesFromContent(this ICakeContext context, string logFileContent)

Examples

Report warnings reported by DocFx to a TFS pull request:

var repoRoot = new DirectoryPath("c:\repo");
    ReportIssuesToPullRequest(
        DocFxIssuesFromContent(
            logFileContent),
        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.
logFileContent string Content of the the DocFx log file.

Return Value

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