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

Obsolete use aliases from DocFxBuildAliases instead.

Assembly

Cake.DocFx.dll

Namespace

Cake.DocFx

Base Types

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

Syntax

public class DocFxSettings : ToolSettings

Name	Summary
DocFxSettings()

Name	Value	Summary
OutputPath	DirectoryPath	Gets or sets the output folder. The default is _site, and is configured in the 'build' section of docfx.json.

Name	Value	Summary
Dump<DocFxSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<DocFxSettings>(DocFxSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<DocFxSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<DocFxSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<DocFxSettings>(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<DocFxSettings>(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
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin