DocCreatorSettings Class

Assembly
Cake.DocCreator.dll
Namespace
Cake.DocCreator
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["DocCreatorSettings"] class Type type-node

Syntax

public class DocCreatorSettings : ToolSettings

Constructors

Name Summary
DocCreatorSettings()
DocCreatorSettings(Path, DirectoryPath)

Properties

Name Value Summary
Arguments IList<string>
InputPath Path
OfflineMode bool
OutputPath DirectoryPath

Methods

Name Value Summary
Build(ProcessArgumentBuilder) void
EnableDebug(bool) DocCreatorSettings
EnableLinkRewrite(bool) DocCreatorSettings
EnableOfflineMode(bool) DocCreatorSettings
OutputToPath(DirectoryPath) DocCreatorSettings
With(Theme) DocCreatorSettings
WithTitle(string) DocCreatorSettings

Extension Methods

Name Value Summary
Dump<DocCreatorSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<DocCreatorSettings>(DocCreatorSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<DocCreatorSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<DocCreatorSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<DocCreatorSettings>(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
ThrowIfNull<DocCreatorSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin