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
-
- ToolSettings
graph BT
Type-->Base0["ToolSettings"]
Type["DocFxSettings"]
class Type type-node
Syntax
public class DocFxSettings : ToolSettingsConstructors
| 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 |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
| IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
| NotNull |
void |
Throws an exception if the specified parameter's value is null.
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
| ThrowIfNull |
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 |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
| ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|