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.Build.DocFxBuildRunner.
- Assembly
- Cake
.DocFx .dll - Namespace
- Cake
.DocFx .Build - Base Types
-
- ToolSettings
- BaseDocFxLogSettings
graph BT
Type-->Base0["BaseDocFxLogSettings"]
click Base0 "/api/Cake.DocFx/BaseDocFxLogSettings"
Base0-->Base1["ToolSettings"]
Type["DocFxBuildSettings"]
class Type type-node
Syntax
public class DocFxBuildSettings : BaseDocFxLogSettingsConstructors
| Name | Summary |
|---|---|
| DocFxBuildSettings |
Properties
| Name | Value | Summary |
|---|---|---|
| CorrelationId | string |
Gets or sets the correlation id used for logging.
Inherited from BaseDocFxLogSettings
|
| Force | bool |
Gets or sets a value indicating whether all the documentation is re-build.
|
| GlobalMetadata | Dictionary |
Gets global metadata.
It overrides the globalMetadata settings from the config file.
See
DocFxGlobalMetadata for constants for metadata keys.
|
| LogLevel | DocFxLogLevel |
Gets or sets to which log level will be logged.
Inherited from BaseDocFxLogSettings
|
| LogPath | FilePath |
Gets or sets the path and file name where the log file generated by DocFx will be saved.
Inherited from BaseDocFxLogSettings
|
| OutputPath | DirectoryPath |
Gets or sets the output folder. The default is _site, and is configured in the 'build'
section of docfx.json.
|
| RepositoryRoot | DirectoryPath |
Gets or sets the Git repository root folder.
Inherited from BaseDocFxLogSettings
|
| Serve | bool |
Gets or sets a value indicating whether to enable previewing of the generated documentation
in a built in web server.
|
| TemplateFolder | DirectoryPath |
Gets or sets the template path to use. If not specified, the default template configured
in the 'build' section of docfx.json will be used.
|
| WarningsAsErrors | bool |
Gets or sets a value indicating if warnings should be treated as errors.
Inherited from BaseDocFxLogSettings
|
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 |
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
|
| To |
string |
From StringExtensions
Requires the Cake.Issues addin
|