DocDirectiveTag class final
A documentation directive, found in a doc comment.
Documentation directives are declared with {@ at the start of a line of a
documentation comment, followed the name of a doc directive, arguments, and
finally a right curly brace (}).
Arguments are separated from the directive name, and from each other, by
whitespace. There are two types of arguments: positional and named. Named
arguments are written as NAME=VALUE, without any internal whitespace.
Named arguments can be optional.
- Annotations
-
- @experimental
Constructors
-
DocDirectiveTag({required int offset, required int end, required int nameOffset, required int nameEnd, required DocDirectiveType type, required List<
DocDirectiveArgument> positionalArguments, required List<DocDirectiveNamedArgument> namedArguments})
Properties
- end → int
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
namedArguments
→ List<
DocDirectiveNamedArgument> -
final
- nameEnd → int
-
final
- nameOffset → int
-
final
- offset → int
-
The offset of the starting text; for example: '@animation'.
final
-
positionalArguments
→ List<
DocDirectiveArgument> -
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- type → DocDirectiveType
-
final
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