Dartdoc class

Generates Dart documentation for all public Dart libraries in the given directory.

Properties

config DartdocOptionContext
final
generator Generator
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
onCheckProgress Stream<String>
no setter
packageBuilder PackageBuilder
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

executeGuarded() → void
Runs generateDocs function and properly handles the errors.
generateDocs() Future<DartdocResults>
Generates Dartdoc documentation.
generateDocsBase() Future<DartdocResults>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

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

Static Methods

fromContext(DartdocGeneratorOptionContext context, PackageBuilder packageBuilder) Future<Dartdoc>
Asynchronous factory method that builds Dartdoc with a generator determined by the given context.
withEmptyGenerator(DartdocOptionContext config, PackageBuilder packageBuilder) Dartdoc
Factory method that builds Dartdoc with an empty generator.