DocumentationBuilder class

Generates markdown documentation files from markdown template files. This can be useful when you write documentation for a Dart or Flutter project and want to reuse/import Dart code or Dart documentation comments.

It can generate the following files:

documentation_builder is not intended to generate API documentation. Use dartdoc instead.

Constructors

DocumentationBuilder()

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
run({bool publishWikiPagesOnGitHub = false}) → dynamic
The documentation_builder uses several builders that are run with the build_runner package.
runInShell(String executable, List<String> arguments, {String? workingDirectory, Map<String, String>? environment, Encoding? stdoutEncoding = systemEncoding, Encoding? stderrEncoding = systemEncoding}) → dynamic
toString() → String
A string representation of this object.
inherited

Operators

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