Category class

A category is a subcategory of a package, containing libraries tagged with a @category identifier.

Inheritance
Implemented types
Mixed in types

Constructors

Category(String _name, Package _package, DartdocOptionContext _config)

Properties

canonicalLibrary Library
read-only, override
categoryDefinition CategoryDefinition
read-only
categoryIndex int
The position in the container order for this category.
read-only
categoryLabel String
read-only
classes Iterable<Class>
read-only, override
commentRefs List<ModelCommentReference>
read-only, inherited
config DartdocOptionContext
@Deprecated('Field intended to be final; setter will be removed as early as ' 'Dartdoc 1.0.0'), read / write, override-getter
constants Iterable<TopLevelVariable>
read-only, override
containerOrder List<String>
Order by which this container should be sorted.
read-only, override
documentation String
read-only, inherited
documentationAsHtml String
read-only, inherited
documentationFile File
read-only, override
documentationFrom List<Locatable>
read-only, override
documentationIsLocal bool
True if documentationFrom contains only one item, this.
read-only, inherited
documentedWhere DocumentLocation
read-only, override
element Element
read-only
enclosingElement → Warnable
read-only
enclosingName String
The name of the container or object that this LibraryContainer is a part of. Used for sorting in containerOrder.
read-only, override
enums Iterable<Enum>
read-only, override
exceptions Iterable<Class>
read-only, override
extensions Iterable<Extension>
read-only, override
filePath String
read-only
fileType String
@Deprecated('Public field intended to be private; will be removed as early as ' 'Dartdoc 1.0.0'), read-only
fullyQualifiedName String
read-only, override
functions Iterable<ModelFunction>
read-only, override
hasDocumentation bool
read-only, inherited
hasExtendedDocumentation bool
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
hasPublicClasses bool
read-only, inherited
hasPublicConstants bool
read-only, inherited
hasPublicEnums bool
read-only, inherited
hasPublicExceptions bool
read-only, inherited
hasPublicExtensions bool
read-only, inherited
hasPublicFunctions bool
read-only, inherited
hasPublicLibraries bool
read-only, inherited
hasPublicMixins bool
read-only, inherited
hasPublicProperties bool
read-only, inherited
hasPublicTypedefs bool
read-only, inherited
href String
read-only, override
isCanonical bool
read-only, override
isDocumented bool
read-only, override
isSdk bool
Does this container represent the SDK? This can be false for containers that only represent a part of the SDK.
read-only, inherited
kind String
read-only, override
libraries List<Library>
final, inherited
linkedName String
read-only
location String
A string indicating the URI of this Locatable, usually derived from Element.location.
read-only, inherited
locationPieces Set<String>
Pieces of the location, split to remove 'package:' and slashes.
read-only, inherited
mixins Iterable<Mixin>
read-only, override
name String
read-only, override
namePart String
Utility getter/cache for _MarkdownCommentReference._getResultsForClass.
read-only, inherited
namePieces Set<String>
read-only, inherited
oneLineDoc String
read-only, inherited
overriddenDepth int
read-only, inherited
package Package
@Deprecated('Field intended to be final; setter will be removed as early as ' 'Dartdoc 1.0.0'), read / write
packageGraph PackageGraph
read-only, override
properties Iterable<TopLevelVariable>
read-only, override
publicClasses Iterable<Class>
read-only, inherited
publicConstants Iterable<TopLevelVariable>
read-only, inherited
publicEnums Iterable<Enum>
read-only, inherited
publicExceptions Iterable<Class>
read-only, inherited
publicExtensions Iterable<Extension>
read-only, inherited
publicFunctions Iterable<ModelFunctionTyped>
read-only, inherited
publicLibraries Iterable<Library>
read-only, inherited
publicMixins Iterable<Mixin>
read-only, inherited
publicProperties Iterable<TopLevelVariable>
read-only, inherited
publicTypedefs Iterable<Typedef>
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
sortKey String
Sorting key. containerOrder should contain these.
read-only, override
typedefs Iterable<Typedef>
read-only, override

Methods

addItem(Categorization c) → void
compareTo(LibraryContainer other) int
Compares this object to another Comparable [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
scoreCanonicalCandidates(Iterable<Library> libraries) List<ScoredCandidate>
inherited
scoreElementWithLibrary(Library lib) ScoredCandidate
@Deprecated('Public method intended to be private; will be removed as early as ' 'Dartdoc 1.0.0'), inherited
toString() String
Returns a string representation of this object.
inherited
warn(PackageWarning kind, {String message, Iterable<Locatable> referredFrom, Iterable<String> extendedDebug}) → void

Operators

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