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 Map<String, ModelCommentReference>
A map of ModelCommentReference.codeRef to ModelCommentReference. This map deduplicates comment references as all identical reference strings inside a single documentation comment will point to the same place, so it should not be used to count exactly how many references there are.
read-only, override
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
library Library
read-only, 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 / write, inherited-setter, override-getter
properties Iterable<TopLevelVariable>
read-only, override
publicClasses Iterable<Class>
read-only, inherited
publicClassesSorted Iterable<Container>
read-only, inherited
publicConstants Iterable<TopLevelVariable>
read-only, inherited
publicConstantsSorted Iterable<TopLevelVariable>
read-only, inherited
publicEnums Iterable<Enum>
read-only, inherited
publicEnumsSorted Iterable<Enum>
read-only, inherited
publicExceptions Iterable<Class>
read-only, inherited
publicExceptionsSorted Iterable<Class>
read-only, inherited
publicExtensions Iterable<Extension>
read-only, inherited
publicExtensionsSorted Iterable<Extension>
read-only, inherited
publicFunctions Iterable<ModelFunctionTyped>
read-only, inherited
publicFunctionsSorted Iterable<ModelFunctionTyped>
read-only, inherited
publicLibraries Iterable<Library>
read-only, inherited
publicLibrariesSorted Iterable<Library>
read-only, inherited
publicMixins Iterable<Mixin>
read-only, inherited
publicMixinsSorted Iterable<Mixin>
read-only, inherited
publicProperties Iterable<TopLevelVariable>
read-only, inherited
publicPropertiesSorted Iterable<TopLevelVariable>
read-only, inherited
publicTypedefs Iterable<Typedef>
read-only, inherited
publicTypedefsSorted Iterable<Typedef>
read-only, inherited
referenceChildren Map<String, CommentReferable>
Map of referenceName to the elements that are a member of this, but not this model element itself. Can be cached. [...]
read-only
referenceGrandparentOverrides Iterable<CommentReferable>
Replace the parents of parents. referenceBy ignores whatever might otherwise be implied by the referenceParents of referenceParents, replacing them with this.
read-only, inherited
referenceName String
read-only, inherited
referenceParents Iterable<CommentReferable>
Iterable of immediate "parents" to try resolving component parts. referenceBy stops at the first parent where a part is found. Can be cached.
read-only
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
scope Scope
For any CommentReferable where an analyzer Scope exists (or can be constructed), implement this. This will take priority over lookups via referenceChildren. Can be cached.
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
childLookups(List<String> reference) Iterable<ReferenceChildrenLookup>
A list of lookups that should be attempted on children based on reference. This allows us to deal with libraries that may have separators in them. referenceBy stops at the first one found.
inherited
compareTo(LibraryContainer other) int
Compares this object to another object. [...]
inherited
lookupViaScope(ReferenceChildrenLookup referenceLookup, bool allowTree(CommentReferable), bool filter(CommentReferable)) → CommentReferable
Looks up references by scope, skipping over results that do not match the given filter. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
recurseChildrenAndFilter(ReferenceChildrenLookup referenceLookup, CommentReferable result, {bool allowTree(CommentReferable), bool filter(CommentReferable)}) → CommentReferable
Given a result found in an implementation of lookupViaScope or _lookupViaReferenceChildren, recurse through children, skipping over results that do not match the filter.
inherited
referenceBy(List<String> reference, {bool tryParents = true, bool filter(CommentReferable), bool allowTree(CommentReferable), Iterable<CommentReferable> parentOverrides}) → CommentReferable
Look up a comment reference by its component parts. If tryParents is true, try looking up the same reference in any parents of this. Will skip over results that do not pass a given filter and keep searching. Will skip over entire subtrees whose parent node does not pass allowTree.
@nonVirtual, 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
A string representation of this object. [...]
inherited
warn(PackageWarning kind, {String message, Iterable<Locatable> referredFrom, Iterable<String> extendedDebug}) → void
inherited

Operators

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