Summary
Contains settings used by
DocFxPdfRunner.
- Namespace
- Cake
.DocFx .Pdf - Base Types
-
- ToolSettings
- BaseDocFxLogSettings
graph BT
Type-->Base0["BaseDocFxLogSettings"]
click Base0 "/Cake.DocFx/api/Cake.DocFx/BaseDocFxLogSettings"
Base0-->Base1["ToolSettings"]
Type["DocFxPdfSettings"]
class Type type-node
Syntax
public class DocFxPdfSettings : BaseDocFxLogSettingsProperties
| Name | Value | Summary |
|---|---|---|
| CorrelationId | string |
Gets or sets the correlation id used for logging.
Inherited from BaseDocFxLogSettings
|
| 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
|
| Name | string |
Gets or sets the name of the generated PDF.
|
| OutputPath | DirectoryPath |
Gets or sets the output base directory.
|
| RepositoryRoot | DirectoryPath |
Gets or sets the Git repository root folder.
Inherited from BaseDocFxLogSettings
|
| TemplateFolder | DirectoryPath |
Gets or sets the template path to use.
|
| WarningsAsErrors | bool |
Gets or sets a value indicating if warnings should be treated as errors.
Inherited from BaseDocFxLogSettings
|