DocDirectiveParameterFormat enum

The expected format of a doc directive parameter, which indicates some minimal validation that can produce diagnostics.

Inheritance
Annotations
  • @experimental

Constructors

DocDirectiveParameterFormat(String displayString)
const

Values

any → const DocDirectiveParameterFormat

A format indicating that arguments are not validated.

const DocDirectiveParameterFormat('any')
integer → const DocDirectiveParameterFormat

A format indicating that an argument must be parsable as an integer.

const DocDirectiveParameterFormat('an integer')
uri → const DocDirectiveParameterFormat

A format indicating that an argument must be parsable as a URI.

const DocDirectiveParameterFormat('a URI')
youtubeUrl → const DocDirectiveParameterFormat

A format indicating that an argument must be parsable as a URI, and be in the format of a YouTube video URL.

const DocDirectiveParameterFormat("a YouTube URL, starting with '$youtubeUrlPrefix'")

Properties

displayString String
final
hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

values → const List<DocDirectiveParameterFormat>
A constant List of the values in this enum, in order of their declaration.
youtubeUrlPrefix → const String