DocumentationIcon class

A class annotation to provide a URL to an image that represents the class.

Each class should only have one DocumentationIcon.

Sample code

/// Utility class for beginning a dream-sharing sequence.
/// ...documentation...
@Category(const <String>['Military Technology', 'Experimental'])
@DocumentationIcon('https://docs.example.org/icons/top.png')
class DreamSharing {
  // ...code...
}

See also:

  • Category, to help place the class in an index.
  • Summary, which is used to provide a one-line description of a class that overrides the inline documentations' own description.

Constructors

DocumentationIcon(String url)
Create an annotation to provide a URL to an image describing a class.
const

Properties

url String
The URL to an image that represents the annotated class.
final
hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) bool
The equality operator. [...]
inherited