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

Describes tool argument named values related to settings MkDocsSettings.

Assembly

Cake.MkDocs.dll

Namespace

Cake.MkDocs.Attributes

Base Types

Attribute

graph BT Type-->Base0["Attribute"] Type["MkDocsArgumentValueAttribute"] class Type type-node

Syntax

public sealed class MkDocsArgumentValueAttribute : Attribute

Examples

 public enum SpecialTypes
 {
     [MkDocsArgumentValue("not-special")]
     NotSpecial,
     [MkDocsArgumentValue("special")]
     Special
 }
 [MkDocsCommand("do-special")]
 public class SpecialCommandSettings : MkDocsSettings
 {
     [MkDocsArgument("special-name", "s")]
     public SpecialTypes Name { get; set; }
 }

 var settings = new SpecialCommandSettings() { Name = SpecialTypes.NotSpecial };

 // Addin tool will execute process with arguments: "mkdocs do-special --special-name not-special"

Attributes

Type	Description
AttributeUsageAttribute

Constructors

Name	Summary
MkDocsArgumentValueAttribute(string)	Initializes a new instance of the `MkDocsArgumentValueAttribute` class.

Properties

Name	Value	Summary
Value	string	Gets tool argument value.

Extension Methods

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