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 related to settings MkDocsSettings.

Assembly

Cake.MkDocs.dll

Namespace

Cake.MkDocs.Attributes

Base Types

Attribute

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

Syntax

public sealed class MkDocsArgumentAttribute : Attribute

Examples

 [MkDocsCommand("do-special")]
 [MkDocsArgument("verbose", "v")]
 public class SpecialCommandSettings : MkDocsSettings
 {
 }

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

 [MkDocsCommand("do-special")]
 public class SpecialCommandSettings : MkDocsSettings
 {
     [MkDocsArgument("special-name", "s", Quoted = true)]
     public string Name { get; set; }
 }

 var settings = new SpecialCommandSettings() { Name = "NameOfSomething" };

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

Attributes

Type	Description
AttributeUsageAttribute

Constructors

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

Fields

Name	Constant Value	Summary
ArgumentPrefix	--	Prefix of argument. static
ShortArgumentPrefix	-	Prefix of short version argument. static

Properties

Name	Value	Summary
Argument	string	Gets tool argument.
Quoted	bool	Gets or sets a value indicating whether argument should be quoted.
ShortArgument	string	Gets or sets tool arguments (one letter version).

Extension Methods

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

MkDocsArgumentAttribute Class