Package class

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

Inheritance
Implemented types
Mixed in types

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. Not sorted.
final
baseHref String
read-only
canonicalLibrary Library
read-only, override
categories List<Category>
read-only
categoriesWithPublicLibraries Iterable<LibraryContainer>
read-only
commentRefs List<ModelCommentReference>
read-only, inherited
config DartdocOptionContext
read-only, override
containerOrder List<String>
Order by which this container should be sorted.
read-only, override
defaultCategory LibraryContainer
read-only
documentation String
read-only, override
documentationAsHtml String
read-only, override
documentationFile File
read-only
documentationFrom List<Locatable>
read-only, override
documentationIsLocal bool
True if documentationFrom contains only one item, this.
read-only, inherited
documentedCategories Iterable<Category>
read-only
documentedWhere DocumentLocation
read-only
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
filePath String
read-only
fileType String
read-only
fullyQualifiedName String
read-only, override
hasCategories bool
Return true if the code has defined non-default categories for libraries in this package.
read-only
hasDocumentation bool
read-only, override
hasDocumentationFile bool
read-only
hasDocumentedCategories bool
read-only
hasExtendedDocumentation bool
read-only, override
hashCode int
The hash code for this object. [...]
read-only, inherited
hasHomepage bool
read-only
hasPublicLibraries bool
read-only, inherited
homepage String
read-only
href String
read-only, override
isCanonical bool
read-only, override
isDocumented bool
read-only, 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).
read-only
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.
read-only
isPublic 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, override
kind String
read-only
libraries List<Library>
final, inherited
location String
A string indicating the URI of this Locatable, usually derived from Element.location.
read-only, override
locationPieces Set<String>
Pieces of the location, split to remove 'package:' and slashes.
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
nameToCategory Map<String, Category>
A map of category name to the category itself.
read-only
oneLineDoc String
read-only, override
package Package
read-only
packageGraph PackageGraph
read-only, override
packageMeta PackageMeta
read-only
packagePath String
read-only
publicLibraries Iterable<Library>
read-only, override
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
sortKey String
Sorting key. containerOrder should contain these.
read-only, inherited
toolInvocationIndex int
Number of times we have invoked a tool for this package.
read / write
usedAnimationIdsByHref Map<String, Set<String>>
read / write
version String
read-only

Methods

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