MkDocsArgumentValueAttribute Class

Summary

Describes tool argument named values related to settings MkDocsSettings.
Namespace
Cake.MkDocs.Attributes
Base Types
  • object
  • Attribute
graph BT Type-->Base0["Attribute"] Base0-->Base1["object"] Type["MkDocsArgumentValueAttribute"] class Type type-node

Syntax

[AttributeUsage(AttributeTargets.Field)]
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.
GitHub