CategoryDefinition class

Defines the attributes of a category in the options file, corresponding to the 'categories' keyword in the options file, and populated by the CategoryConfiguration class.

Constructors

CategoryDefinition.new(String? name, String? _displayName, String? documentationMarkdown, {List<ExternalItem> externalItems = const []})

Properties

displayName → String

Returns the _displayName, if available, or else simply name.

no setter

documentationMarkdown → String?

Canonical path of the markdown file used to document this category (or null if undocumented).

final

externalItems → List<ExternalItem>

The external items defined for this category.

final

hashCode → int

The hash code for this object.

no setter, inherited

name → String?

Internal name of the category, or null for the default category.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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