Summary class

An annotation that provides a short description of a class for use in an index.

Usually the first paragraph of the documentation for a class can be used for this purpose, but on occasion the first paragraph is either too short or too long for use in isolation, without the remainder of the documentation.

Sample code

/// A famous cat.
///
/// Instances of this class can hunt small animals.
/// This cat has three legs.
@Category(const <String>['Animals', 'Cats'])
@Category(const <String>['Cute', 'Pets'])
@DocumentationIcon('https://www.examples.net/docs/images/icons/pillar.jpeg')
@Summary('A famous three-legged cat.')
class Pillar extends Cat {
  // ...code...
}

See also:

  • Category, to help place the class in an index.
  • DocumentationIcon, which is used to give the URL to an image that represents the class.

Constructors

Summary(String text)
Create an annotation to provide a short description of a class.
const

Properties

text String
The text of the summary of 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