PubPackageBuilder class

A package builder that understands pub package format.

Implemented types

Constructors

PubPackageBuilder(DartdocOptionContext config, PackageMetaProvider packageMetaProvider, PackageConfigProvider packageConfigProvider)

Properties

config → DartdocOptionContext
final
driver → AnalysisDriver
read-only
embedderResolver → DartUriResolver
read-only
embedderSdk → EmbedderSdk
read-only
hasEmbedderSdkFiles → bool
read-only
hashCode → int
The hash code for this object. [...]
read-only, inherited
packageConfigProvider → PackageConfigProvider
final
packageMetaProvider → PackageMetaProvider
final
resourceProvider → ResourceProvider
read-only
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
sdk → DartSdk
read-only
sourceFactory → SourceFactory
read-only

Methods

buildPackageGraph() → Future<PackageGraph>
override
findFilesToDocumentInPackage(String basePackageDir, {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>
getSdkFilesToDocument() → Iterable<String>
Return an Iterable with the sdk files we should parse. Filter can be String or RegExp (technically, anything valid for String.contains)
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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
Returns a string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator. [...]
inherited