MkDocsVersionSettings Class

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.MkDocs.

Summary

Contains settings used by MkDocsVersionRunner.

Assembly

Cake.MkDocs.dll

Namespace

Cake.MkDocs.Version

Base Types

ToolSettings
MkDocsSettings

graph BT Type-->Base0["MkDocsSettings"] click Base0 "/api/Cake.MkDocs/MkDocsSettings" Base0-->Base1["ToolSettings"] Type["MkDocsVersionSettings"] class Type type-node

Syntax

public sealed class MkDocsVersionSettings : MkDocsSettings

Attributes

Type	Description
MkDocsArgumentAttribute	Describes tool argument related to settings `MkDocsSettings`.

Constructors

Name	Summary
MkDocsVersionSettings()

Properties

Name	Value	Summary
Quiet	bool	Gets or sets a value indicating whether quiet mode is enabled. Silence warnings. Inherited from MkDocsSettings
Verbose	bool	Gets or sets a value indicating whether verbose mode is enabled. Enable verbose output. Inherited from MkDocsSettings

Extension Methods

Name	Value	Summary
Dump<MkDocsVersionSettings>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<MkDocsVersionSettings>(MkDocsVersionSettings[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<MkDocsVersionSettings>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
NotNull<MkDocsVersionSettings>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
ThrowIfNull<MkDocsVersionSettings>(string, string)	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<MkDocsVersionSettings>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin
ToStringWithNullMarkup()	string	Returns the string value or a `Not set`> markup suitable for Spectre.Console. From StringExtensions Requires the Cake.Issues addin