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

Summary

Allows you to describe how to use a task argument through an example value. You can use multiple of these attributes.

Assembly

Cake.Sprinkles.Module.dll

Namespace

Cake.Sprinkles.Module.Annotations.Arguments

Base Types

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

Syntax

public class TaskArgumentExampleValueAttribute : Attribute

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

Name	Value	Summary
UsageExample	string	Gets the example of how to use the Task Argument.

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