BaseDocFxLogSettings Class

Summary

Base class for all settings supporting logging.
graph BT Type-->Base0["ToolSettings"] Type["BaseDocFxLogSettings"] class Type type-node Derived0["DocFxMetadataSettings"]-->Type click Derived0 "/api/Cake.DocFx.Metadata/DocFxMetadataSettings" Derived1["DocFxBuildSettings"]-->Type click Derived1 "/api/Cake.DocFx.Build/DocFxBuildSettings" Derived2["DocFxMergeSettings"]-->Type click Derived2 "/api/Cake.DocFx.Merge/DocFxMergeSettings" Derived3["DocFxPdfSettings"]-->Type click Derived3 "/api/Cake.DocFx.Pdf/DocFxPdfSettings"

Syntax

public abstract class BaseDocFxLogSettings : ToolSettings

Constructors

Name Summary
BaseDocFxLogSettings()

Properties

Name Value Summary
CorrelationId string
Gets or sets the correlation id used for logging.
LogLevel DocFxLogLevel
Gets or sets to which log level will be logged.
LogPath FilePath
Gets or sets the path and file name where the log file generated by DocFx will be saved.
RepositoryRoot DirectoryPath
Gets or sets the Git repository root folder.
WarningsAsErrors bool
Gets or sets a value indicating if warnings should be treated as errors.

Extension Methods

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