An abstract class that defines a generator that generates documentation for a given package.
Generators can generate documentation in different formats: html, json etc.
Constructors
Properties
- onFileCreated → Stream<File>
-
Fires when a file is created.
read-only
- writtenFiles → Set<String>
-
Fetches all filenames written by this generator.
read-only
- hashCode → int
-
The hash code for this object.
read-only, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Methods
-
generate(
Package package, Directory out) → Future - Generate the documentation for the given package in the specified directory. Completes the returned future when done.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited
-
toString(
) → String -
Returns a string representation of this object.
inherited
Operators
-
operator ==(
other) → bool -
The equality operator.
inherited