DocumentationBuilder class Null safety

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:

  • README.md file
  • CHANGELOG.mdt file
  • example.md file
  • Github Wiki pages (also markdown files)

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

Constructors

DocumentationBuilder()

Properties

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

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
run() → dynamic
The documentation_builder uses several builder that are run with the build_runner package. [...]
toString() String
A string representation of this object. [...]
inherited

Operators

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