Library class

Inheritance
Mixed in types

Constructors

Library(LibraryElement element, PackageGraph packageGraph)
factory
Library.fromLibraryResult(DartDocResolvedLibrary resolvedLibrary, PackageGraph packageGraph, Package package)
factory

Properties

allCanonicalModelElements Iterable<ModelElement>
read-only
allClasses List<Class>
read-only
allModelElements Iterable<ModelElement>
read-only
allOriginalModelElementNames Iterable<String>
@Deprecated('Public getter intended to be private; will be removed as early as ' 'Dartdoc 1.0.0'), read-only
allParameters List<Parameter>
read-only, inherited
annotations Iterable<Annotation>
read-only, inherited
canonicalFor Set<String>
read-only
canonicalLibrary Library
read-only, inherited
canonicalModelElement ModelElement
read-only, inherited
categories Iterable<Category>
read-only, inherited
categoryNames List<String>
Either a set of strings containing all declared categories for this symbol, or a set containing Null if none were declared.
read-only, inherited
characterLocation CharacterLocation
read-only, override
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, inherited
compilationUnitElement CompilationUnitElement
read-only, override
computeDocumentationFrom List<ModelElement>
Returns the ModelElement(s) from which we will get documentation. Can be more than one if this is a Field composing documentation from multiple Accessors. [...]
read-only, inherited
config DartdocOptionContext
read-only, inherited
constants Iterable<TopLevelVariable>
read-only, override
definingLibrary Library
read-only, inherited
dirName String
read-only
displayedCategories Iterable<Category>
read-only, inherited
displayedLanguageFeatures Iterable<LanguageFeature>
A list of language features that both apply to this ModelElement and make sense to display in context.
read-only, inherited
documentation String
Returns the docs, stripped of their leading comments syntax.
read-only, inherited
documentationAsHtml String
read-only, inherited
documentationComment String
read-only, inherited
documentationFrom List<ModelElement>
read-only, inherited
documentationIsLocal bool
True if documentationFrom contains only one item, this.
read-only, inherited
documentationLocal String
read-only, inherited
element LibraryElement
read-only, override
enclosingElement ModelElement
Libraries are not enclosed by anything.
read-only
enums List<Enum>
read-only, override
exceptions List<Class>
read-only, override
exportedInLibraries Set<Library>
read-only, inherited
Returns a link to extended documentation, or the empty string if that does not exist.
read-only, inherited
extensions Iterable<Extension>
read-only, override
features Set<Feature>
Usually a superset of annotations except where _specialFeatures replace them, a list of annotations as well as tags applied by Dartdoc itself when it notices characteristics of an element that need to be documented. See Feature for a list.
read-only, inherited
featuresAsString String
read-only, inherited
fileName String
read-only, override
filePath String
read-only, override
fileType String
read-only, inherited
fullyQualifiedName String
Returns the fully qualified name. [...]
read-only, inherited
fullyQualifiedNameWithoutLibrary String
read-only, inherited
functions List<ModelFunction>
read-only, override
hasAnnotations bool
read-only, inherited
hasCategorization bool
True if categories, subcategories, a documentation icon, or samples were declared.
read-only, inherited
hasCategoryNames bool
read-only, inherited
hasDocumentation bool
read-only, inherited
hasExtendedDocumentation bool
read-only, inherited
hasFeatures bool
read-only, inherited
hasFeatureSet bool
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
hasImage bool
read-only, inherited
hasNodoc bool
Returns true if the raw documentation comment has a nodoc indication.
read-only, inherited
hasParameters bool
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
hasPublicMixins bool
read-only, inherited
hasPublicProperties bool
read-only, inherited
hasPublicTypedefs bool
read-only, inherited
hasSamples bool
read-only, inherited
hasSourceCode bool
read-only, inherited
hasSourceHref bool
read-only, inherited
hasSubCategoryNames bool
read-only, inherited
href String
If canonicalLibrary (or canonicalEnclosingElement, for Inheritable subclasses) is null, href should be null.
read-only, override
htmlId String
read-only, inherited
image String
Either a URI to a defined image, or the empty string if none was declared.
read-only, inherited
importedExportedLibraries Set<Library>
Returns all libraries either imported by or exported by this library, recursively.
read-only
inheritanceManager → InheritanceManager3
read-only
isAnonymous bool
read-only
isAsynchronous bool
read-only, inherited
isCallable bool
read-only, inherited
isCanonical bool
read-only, inherited
isConst bool
read-only, inherited
isDeprecated bool
read-only, inherited
isDocumented bool
read-only, inherited
isExecutable bool
read-only, inherited
isFinal bool
read-only, inherited
isInSdk bool
read-only
isLate bool
read-only, inherited
isLocalElement bool
read-only, inherited
isNullSafety bool
Return true if this library should be documented as using Null safety. A library may use Null safety but not documented that way.
read-only
isPropertyAccessor bool
read-only, inherited
isPropertyInducer bool
read-only, inherited
isPublic bool
read-only, override
isPublicAndPackageDocumented bool
read-only, inherited
isStatic bool
read-only, inherited
kind String
A human-friendly name for the kind of element this is.
read-only, override
library Library
read-only, override
linkedName String
read-only, inherited
linkedParams String
read-only, inherited
linkedParamsLines String
read-only, inherited
linkedParamsNoMetadata String
read-only, inherited
linkedParamsNoMetadataOrNames String
read-only, inherited
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 List<Mixin>
read-only, override
modelElementRenderer → ModelElementRenderer
@visibleForTesting, read-only, inherited
modelElementsMap HashMap<Element, Set<ModelElement>>
read-only
modelElementsNameMap HashMap<String, Set<ModelElement>>
Map of fullyQualifiedNameWithoutLibrary to all matching ModelElements in this library. Used for legacy code reference lookups.
read-only
modelNode ModelNode
read-only, inherited
name String
read-only, override
nameFromPath String
Generate a name for this library based on its location. [...]
read-only
namePart String
Utility getter/cache for _MarkdownCommentReference._getResultsForClass.
read-only, inherited
namePieces Set<String>
read-only, inherited
oneLineDoc String
read-only, inherited
originalMember → Member
read-only, inherited
overriddenDepth int
read-only, inherited
package Package
final
packageGraph PackageGraph
read / write, inherited
packageImportedExportedLibraries Set<Library>
Returns all libraries either imported by or exported by any public library this library's package. (Not PackageGraph, but sharing a package name). [...]
read-only
packageMeta PackageMeta
read-only
packageName String
The name of the package we were defined in.
read-only
parameters List<Parameter>
read-only, inherited
pathContext Context
read-only, inherited
prefixToLibrary Map<String, Set<Library>>
Map of import prefixes ('import "foo" as prefix;') to Library.
read-only
properties Iterable<TopLevelVariable>
All variables ("properties") except constants.
read-only, override
publicClasses Iterable<Class>
read-only, inherited
publicClassesSorted Iterable<Class>
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
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
samples String
Either a URI to documentation with samples, or the empty string if none was declared.
read-only, inherited
scope Scope
Allow scope for Libraries.
read-only
sdkLib → SdkLibrary
read-only
sourceCode String
read-only, inherited
sourceFileName String
read-only, inherited
sourceHref String
read-only, inherited
subCategoryNames List<String>
Either a set of strings containing all declared subcategories for this symbol, or a set containing Null if none were declared.
read-only, inherited
typedefs List<Typedef>
read-only, override
typeSystem TypeSystem
read-only

Methods

buildCanonicalModelElement() ModelElement
inherited
buildDocumentationAddition(String rawDocs) String
Hide canonicalFor from doc while leaving a note to ourselves to help with ambiguous canonicalization determination. [...]
override
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(dynamic other) int
Compares this object to another object. [...]
inherited
computeDocumentationComment() String
Implement to derive the raw documentation comment string from the analyzer.
inherited
getClassByName(String name) Class
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
precacheLocalDocs() Future<void>
Unconditionally precache local documentation. [...]
inherited
processComment(String documentationComment) Future<String>
Process documentationComment, performing various actions based on {@}-style directives, returning the processed result.
inherited
processCommentDirectives(String docs) String
inherited
processCommentWithoutTools(String documentationComment) String
Process a documentationComment, performing various actions based on {@}-style directives, except {@tool}, returning the processed result.
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

Static Methods

getDefinedElements(CompilationUnitElement compilationUnit) Iterable<Element>
@Deprecated('Public method intended to be private; will be removed as early as ' 'Dartdoc 1.0.0')