Implements

Constructors

Package(Iterable<LibraryElement> libraryElements, PackageMeta packageMeta, PackageWarningOptions _packageWarningOptions)

Properties

allCanonicalModelElements → Iterable<ModelElement>
read-only
allHrefs → Map<String, Set<ModelElement>>
A lookup index for hrefs to allow warnings to indicate where a broken link or orphaned file may have come from. Not cached because ModelElements can be created at any time and we're basing this on more than just allModelElements to make the error messages comprehensive.
read-only
allLibrariesAdded ↔ bool
read / write
allModelElements → Iterable<ModelElement>
read-only
categories → List<PackageCategory>
read-only
documentation → String
@override, read-only
documentationAsHtml → String
@override, read-only
documentationFile → FileContents
read-only
documentationFrom → Documentable
@override, read-only
element → Element
@override, read-only
elementLocation → String
@override, read-only
fullyQualifiedName → String
@override, read-only
hasDocumentation → bool
@override, read-only
hasDocumentationFile → bool
read-only
hasExtendedDocumentation → bool
@override, read-only
href → String
@override, read-only
isCanonical → bool
@override, read-only
isSdk → bool
Does this package represent the SDK?
read-only
kind → String
read-only
libraries → List<Library>
read-only
libraryElementReexportedBy → Map<LibraryElement, Set<Library>>
read-only
lineAndColumn → Tuple2<int, int>
@override, read-only
name → String
@override, read-only
objectElement → ModelElement
read-only
oneLineDoc → String
@override, read-only
overriddenDocumentedElement → Documentable
@override, read-only
package → Package
@override, read-only
packageMeta → PackageMeta
final
packageWarningCounter → PackageWarningCounter
read-only
version → String
read-only
hashCode → int
The hash code for this object.
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

addMacro(String name, String content) → void
findCanonicalLibraryFor(Element e) → Library
Tries to find a top level library that references this element.
findCanonicalModelElementFor(Element e, { Class preferredClass }) → ModelElement
Tries to find a canonical ModelElement for this element. If we know this element is related to a particular class, pass preferredClass to disambiguate.
findLibraryFor(Element element) → Library
Looks up some Library that is reexporting this Element; not necessarily the canonical Library.
findOrCreateLibraryFor(Element e) → Library
This is used when we might need a Library object that isn't actually a documentation entry point (for elements that have no Library within the set of canonical Libraries).
getMacro(String name) → String
isDocumented(Element element) → bool
toString() → String
Returns a string representation of this object.
warn(PackageWarning kind, { String message, Locatable referredFrom }) → void
warnOnElement(Warnable warnable, PackageWarning kind, { String message, Locatable referredFrom }) → void
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited

Operators

operator ==(other) → bool
The equality operator.
inherited

Static Methods

getBasestElement(Member member) → Element
nameAndLocation(Locatable locatable) → Tuple2<String, String>
Returns colon-stripped name and location of the given locatable.
withAutoIncludedDependencies(Iterable<LibraryElement> libraryElements, PackageMeta packageMeta, PackageWarningOptions options) → Package