DocFxSettings Class

Summary

Obsolete use aliases from DocFxBuildAliases instead.
Assembly
Cake.DocFx.dll
Namespace
Cake.DocFx
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["DocFxSettings"] class Type type-node

Syntax

public class DocFxSettings : ToolSettings

Constructors

Name Summary
DocFxSettings()

Properties

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.

Extension Methods

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