This content is part of a third party extension that is not supported by the Cake project.

Summary

Allows you to describe an argument to a user of your console application.

Assembly

Cake.Sprinkles.Module.dll

Namespace

Cake.Sprinkles.Module.Annotations.Arguments

Base Types

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

Syntax

public class TaskArgumentDescriptionAttribute : Attribute

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

Name	Value	Summary
Description	string	Gets the Description of the Task Argument.

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