DocFxIssuesSettings Class

Summary

Settings for Cake.Prca.Issues.DocFx.DocFxIssuesProvider.
Assembly
Cake.Prca.Issues.DocFx.dll
Namespace
Cake.Prca.Issues.DocFx
Base Types
  • object
graph TD Base0["object"]-->Type Type["DocFxIssuesSettings"] class Type type-node

Syntax

public class DocFxIssuesSettings

Constructors

Name Summary
DocFxIssuesSettings(FilePath, DirectoryPath) Initializes a new instance of the DocFxIssuesSettings class.
DocFxIssuesSettings(string, DirectoryPath) Initializes a new instance of the DocFxIssuesSettings class.

Properties

Name Value Summary
DocRootPath DirectoryPath
Gets the path to the root directory of the DocFx project. Either the full path or the path relative to the repository root.
LogFileContent string
Gets the content of the log file.

Methods

Name Value Summary
FromContent(string, DirectoryPath) DocFxIssuesSettings
Returns a new instance of the DocFxIssuesSettings class from the content of a DocFx log file.
static
FromFilePath(FilePath, DirectoryPath) DocFxIssuesSettings
Returns a new instance of the DocFxIssuesSettings class from a log file on disk.
static

Extension Methods

Name Value Summary
NotNull<DocFxIssuesSettings>(string) void
Throws an exception if the specified parameter's value is null.
GitHub