DocFxMetadataSettings Class

Summary

Contains settings used by DocFxMetadataRunner.
Assembly
Cake.DocFx.dll
Namespace
Cake.DocFx.Metadata
Base Types
graph BT Type-->Base0["BaseDocFxLogSettings"] click Base0 "/api/Cake.DocFx/BaseDocFxLogSettings" Base0-->Base1["ToolSettings"] Type["DocFxMetadataSettings"] class Type type-node

Syntax

public class DocFxMetadataSettings : BaseDocFxLogSettings

Constructors

Name Summary
DocFxMetadataSettings()

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.
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 api, and is configured in the 'metadata' section of docfx.json.
Projects IEnumerable<FilePath>
Specifies the projects to have metadata extracted. There are several approaches to extract language metadata.
  1. From a supported project file or project file list. Supported project file extensions include .csproj, .vbproj, .sln.
  2. From a supported source code file or source code file list. Supported source code file extensions include .cs and .vb. Files can be combined using , as seperator and search pattern.
  3. From docfx.json file.
If the argument is not specified, docfx.exe will try reading docfx.json under current directory.
RepositoryRoot DirectoryPath
Gets or sets the Git repository root folder.
Inherited from BaseDocFxLogSettings
WarningsAsErrors bool
Gets or sets a value indicating if warnings should be treated as errors.
Inherited from BaseDocFxLogSettings

Extension Methods

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