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.DocFx.

Summary

Contains settings used by Cake.DocFx.Init.DocFxInitRunner.

Assembly

Cake.DocFx.dll

Namespace

Cake.DocFx.Init

Base Types

graph BT Type-->Base0["ToolSettings"] Type["DocFxInitSettings"] class Type type-node

Syntax

public class DocFxInitSettings : ToolSettings

Name	Summary
DocFxInitSettings()

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` .

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