This content is part of a third party extension that is not supported by the Cake project. For more information about this extension see Cake.Issues.DocFx.

Summary

Gets an instance of a provider for warnings reported by DocFx using a log file from disk.

Assembly: Cake.Issues.DocFx.dll
Namespace: Cake.Issues.DocFx
Containing Type: DocFxIssuesAliases

Syntax

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

Examples

Read warnings reported by DocFx:

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

Attributes

Type	Description
CakeMethodAliasAttribute
CakeAliasCategoryAttribute

Parameters

Name	Type	Description
context	ICakeContext	The context.
logFilePath	FilePath	Path to 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
IIssueProvider	Instance of a provider for warnings reported by DocFx.