PubPackageBuilder class

A package builder that understands pub package format.

Implemented types

Constructors

PubPackageBuilder(DartdocOptionContext config, PackageMetaProvider packageMetaProvider, PackageConfigProvider packageConfigProvider, {@visibleForTesting bool skipUnreachableSdkLibraries = false})

Properties

config DartdocOptionContext
final
embedderSdk → EmbedderSdk?
no setter
hasEmbedderSdkFiles bool
no setter
hashCode int
The hash code for this object.
no setterinherited
packageConfigProvider PackageConfigProvider
final
packageMetaProvider PackageMetaProvider
final
pathContext → Context
no setter
resourceProvider → ResourceProvider
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sdk → DartSdk
latefinal

Methods

buildPackageGraph() Future<PackageGraph>
override
findFilesToDocumentInPackage(String basePackageDir, {required bool autoIncludeDependencies, bool filterExcludes = true}) Stream<String>
Given a package name, explore the directory and pull out all top level library files in the "lib" directory to document.
getEmbedderSdkFiles() Iterable<String>
getLibraries(PackageGraph uninitializedPackageGraph) Future<void>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
processLibrary(String filePath) Future<DartDocResolvedLibrary?>
Parse a single library at filePath using the current analysis driver. If filePath is not a library, returns null.
toString() String
A string representation of this object.
inherited

Operators

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