MkDocsVersionRunner Class

Summary

The MkDocs version tool provides information about tool and addin versions compatibility.
graph BT Type-->Base0["MkDocsTool<MkDocsSettings>"] Base0-->Base1["Tool<MkDocsSettings>"] Type["MkDocsVersionRunner"] class Type type-node

Syntax

public sealed class MkDocsVersionRunner : MkDocsTool<MkDocsSettings>

Constructors

Methods

Name Value Summary
IsSupportedVersion(MkDocsSettings) bool
Checks if provided MkDocs tool version is compatible with addin.
Version(MkDocsSettings) Version
Gets provided MkDocs tool version.

Extension Methods

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