Dartdoc class
Generates Dart documentation for all public Dart libraries in the given directory.
Properties
- config → DartdocOptionContext
-
final
- generator → Generator
-
final
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
-
onCheckProgress
→ Stream<
String> -
read-only
- outputDir ↔ Folder
-
read / write
- packageBuilder → PackageBuilder
-
final
- packageGraph ↔ PackageGraph
-
read / write
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
-
writtenFiles
→ Set<
String> -
final
Methods
-
executeGuarded(
[Future< void> postProcessCallback(DartdocOptionContext)]) → void - Runs generateDocs function and properly handles the errors. [...]
-
generateDocs(
) → Future< DartdocResults> -
generateDocsBase(
) → Future< DartdocResults> - Generate Dartdoc documentation. [...]
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toString(
) → String -
A string representation of this object. [...]
inherited
-
validateLinks(
PackageGraph packageGraph, String origin) → void - Don't call this method more than once, and only after you've generated all docs for the Package.
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.
-
withDefaultGenerators(
DartdocGeneratorOptionContext config, PackageBuilder packageBuilder) → Future< Dartdoc> -
An asynchronous factory method that builds Dartdoc's file writers
and returns a Dartdoc object with them.
@Deprecated('Prefer fromContext() instead')
-
withEmptyGenerator(
DartdocOptionContext config, PackageBuilder packageBuilder) → Future< Dartdoc> - Asynchronous factory method that builds Dartdoc with an empty generator.