DocFxInitSettings Class

Summary

Contains settings used by Cake.DocFx.Init.DocFxInitRunner.
Assembly
Cake.DocFx.dll
Namespace
Cake.DocFx.Init
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["DocFxInitSettings"] class Type type-node

Syntax

public class DocFxInitSettings : ToolSettings

Constructors

Name Summary
DocFxInitSettings()

Properties

Name Value Summary
OnlyConfigFile bool
Gets or sets a flag indicating if only the
docfx.json
file should be generated. In this case no project folder will be generated.
OutputPath DirectoryPath
Gets or sets the output folder of the config file. If not specified, the config file will be saved to a new folder
docfx_project
.

Extension Methods

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