DocFxIssuesSettings Class

Summary

Settings for DocFxIssuesAliases.
Assembly
Cake.Issues.DocFx.dll
Namespace
Cake.Issues.DocFx
Base Types
graph BT Type-->Base0["IssueProviderSettings"] click Base0 "/api/Cake.Issues/IssueProviderSettings" Base0-->Base1["Object"] Type["DocFxIssuesSettings"] class Type type-node

Syntax

public class DocFxIssuesSettings : IssueProviderSettings

Constructors

Name Summary
DocFxIssuesSettings(byte[], DirectoryPath) Initializes a new instance of the DocFxIssuesSettings class.
DocFxIssuesSettings(FilePath, 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 byte[]
Gets the content of the log file.
Inherited from IssueProviderSettings

Extension Methods

Name Value Summary
Dump<DocFxIssuesSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DocFxIssuesSettings>(DocFxIssuesSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DocFxIssuesSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<DocFxIssuesSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<DocFxIssuesSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<DocFxIssuesSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin