Category class
A category with which to annotate a class, for documentation purposes.
A category is usually represented as a section and a subsection, each of which is a string. The engineering team that owns the library to which the class belongs defines the categories used for classes in that library. For example, the Flutter engineering team has defined categories like "Basic/Buttons" and "Material Design/Buttons" for Flutter widgets.
A class can have multiple categories.
/// A copper coffee pot, as desired by Ben Turpin.
/// ...documentation...
@Category(<String>['Pots', 'Coffee'])
@Category(<String>['Copper', 'Cookware'])
@DocumentationIcon('https://example.com/images/coffee.png')
@Summary('A proper cup of coffee is made in a proper copper coffee pot.')
class CopperCoffeePot {
// ...code...
}See also:
- DocumentationIcon, which is used to give the URL to an image that represents the class.
- Summary, which is used to provide a one-line description of a class that overrides the inline documentations' own description.
Constructors
Properties
-
sections
→ List<
String> -
The strings the correspond to the section and subsection of the
category represented by this object. [...]
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