Package class

A LibraryContainer that contains Library objects related to a particular package.

Inheritance

• Object
• LibraryContainer
• Package

Implemented types

• Privacy
• Documentable
• Canonicalization
• Nameable

Mixed-in types

• Nameable
• Locatable
• Canonicalization

Constructors

Package.fromPackageMeta(PackageMeta packageMeta, PackageGraph packageGraph)

factory

Properties

allLibraries → Set<Library>

Holds all libraries added to this package. May include non-documented libraries, but is not guaranteed to include a complete list of non-documented libraries unless they are all referenced by documented ones.

final

baseHref → String

late, final

canonicalLibrary → Library?

no setter, override

categories → List<Category>

The categories, sorted alphabetically by name.

late, final

categoriesWithPublicLibraries → Iterable<Category>

no setter

config → DartdocOptionContext

late, final

containerOrder → List<String>

Order by which this container should be sorted.

no setter, override

defaultCategory ↔ Category

The default, unnamed category.

late, final

definingCommentReferable → CommentReferable

For testing / comparison only, get the comment referable from where this ElementType was defined. Override where an Element is available.

no setter, inherited

documentation → String?

late, final

documentationAsHtml → String?

late, final

documentationFrom → List<Locatable>

no setter, override

documentationIsLocal → bool

True if documentationFrom contains only one item, this.

no setter, inherited

documentedCategories → Iterable<Category>

no setter

documentedCategoriesSorted → Iterable<Category>

The documented categories, sorted either by the 'categoryOrder' option, or by name.

no setter

documentedWhere → DocumentLocation

Returns the location of documentation for this package, for linkToRemote and canonicalization decision making.

late, final

element → Element?

no setter

enclosingElement → Warnable?

no setter

enclosingName → String

The name of the container or object that this LibraryContainer is a part of. Used for sorting in containerOrder.

no setter, override

filePath → String

no setter

fileType → String

late, final

fullyQualifiedName → String

no setter, override

hasCategories → bool

Return true if the code has defined non-default categories for libraries in this package.

no setter

hasDocumentation → bool

no setter, override

hasDocumentedCategories → bool

no setter

hashCode → int

The hash code for this object.

no setter, inherited

hasHomepage → bool

no setter

hasPublicLibraries → bool

no setter, inherited

homepage → String

no setter

href → String

no setter, override

isCanonical → bool

no setter, override

isDocumented → bool

no setter, override

isFirstPackage → bool

Is this the package at the top of the list? We display the first package specially (with "Libraries" rather than the package name).

no setter

isLocal → bool

Return true if this is the default package, this is part of an embedder SDK, or if DartdocOptionContext.autoIncludeDependencies is true -- but only if the package was not excluded on the command line.

late, final

isPublic → bool

If we have public libraries, this is the default package, or we are auto-including dependencies, this package is public.

late, final

isSdk → bool

Does this container represent the SDK? This can be false for containers that only represent a part of the SDK.

no setter, override

kind → String

no setter, override

libraries → List<Library>

final, inherited

library → Library?

no setter, inherited

location → String

A string indicating the URI of this Locatable, usually derived from Element.location.

no setter, override

locationPieces → Set<String>

Pieces of the location, split to remove 'package:' and slashes.

no setter, override

modelBuilder → ModelObjectBuilder

Override implementations in unit tests to avoid requiring literal ModelElements.

late, final, inherited

name → String

no setter, override

namePart → String

Utility getter/cache for _MarkdownCommentReference._getResultsForClass.

late, final, inherited

namePieces → Set<String>

late, final, inherited

nameToCategory ↔ Map<String?, Category>

A map of category name to the category itself.

late, final

oneLineDoc → String

no setter, override

package → Package

no setter

packageGraph → PackageGraph

no setter, override

packageMeta → PackageMeta

no setter

packagePath → String

late, final

publicLibraries → Iterable<Library>

no setter, override

publicLibrariesSorted → List<Library>

late, final, 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.

late, final

referenceGrandparentOverrides → Iterable<CommentReferable>?

Replace the parents of parents. referenceBy ignores whatever might otherwise be implied by the referenceParents of referenceParents, replacing them with this.

no setter, inherited

referenceName → String

no setter

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.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, 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.

no setter, inherited

sortKey → String

Sorting key. containerOrder should contain these.

no setter, inherited

toolInvocationIndex ↔ int

Number of times we have invoked a tool for this package.

getter/setter pair

usedAnimationIdsByHref ↔ Map<String?, Set<String>>

getter/setter pair

version → String

no setter

Methods

addToCategories(Categorization categorization, void addTo(Category)) → void

Adds categorization to one or more categories in the nameToCategory map, if it is annoated with {@category}, or `defaultCategory, if not, via the addTo callback.

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

initializeCategories() → void

Initializes the defaultCategory and the nameToCategory map, with all appropriate elements.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

referenceBy(List<String> reference, {required bool filter(CommentReferable?), required bool allowTree(CommentReferable?), bool tryParents = true, Iterable<CommentReferable>? parentOverrides}) → CommentReferable?

Look up a comment reference by its component parts.

inherited

scoreCanonicalCandidates(Iterable<Library> libraries) → List<ScoredCandidate>

inherited

toString() → String

A string representation of this object.

inherited

warn(PackageWarning kind, {String? message, Iterable<Locatable> referredFrom = const [], Iterable<String> extendedDebug = const []}) → void

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited