Generates Dart documentation for all public Dart libraries in the given directory.
Constructors
- DartDoc(Directory rootDir, List<String> excludes, Directory sdkDir, List<Generator> generators, Directory outputDir, PackageMeta packageMeta, List<String> includes, { List<String> includeExternals: const [] })
Properties
- excludes → List<String>
-
final
- generators → List<Generator>
-
final
- includeExternals → List<String>
-
final
- includes → List<String>
-
final
- onCheckProgress → Stream<String>
-
read-only
- outputDir → Directory
-
final
- packageMeta → PackageMeta
-
final
- rootDir → Directory
-
final
- sdkDir → Directory
-
final
- writtenFiles → Set<String>
-
final
- 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
-
generateDocs(
) → Future<DartDocResults> - Generate DartDoc documentation.
-
verifyLinks(
Package package, String origin) → void - Don't call this method more than once, and only after you've generated all docs for the Package.
-
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