documentation_builder library
Classes
- ChangeLogFile
- A CHANGELOG.md is a log or record of all notable changes made to a project. To support tools that parse CHANGELOG.md, use the following format:
- ChangeLogTemplate
- ChangeLogTemplateFactory
- DartCodePathBuilder
-
Finds .dart files, find all the
DartCodePaths for its members and puts them in theDocumentationModel - DocumentationBuilder
- 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.
-
DocumentationFactory<
T extends Template> - DocumentationFile
- Represents a documentation file. This could be a Template or an other type of file in the doc folder of a project (e.g. a picture).
- DocumentationFileFactories
- DocumentationModelBuilder
-
Finds documentation files in the project's doc folder,
and puts them in the
DocumentationModel - ExampleFile
- Your Dart/Flutter project can have an example.md file A example.mdt is a TemplateFile that is used by the DocumentationBuilder to create or override the example.md file in the example folder of your dart project. The example.mdt file is stored in the doc/template folders in the root of the project
- ExampleTemplate
- ExampleTemplateFactory
- GeneratedFile
- The DocumentationBuilder converts TemplateFiles to GeneratedFiles. It will replace the following with generated text:
- LicenseFactory
- LicenseFile
- Public repositories on GitHub are often used to share open source software. For your repository to truly be open source, you'll need to license it so that others are free to use, change, and distribute the software.
- LicenseTemplate
- MarkdownTemplateFile
- MarkdownTemplateFiles are TemplateFiles that have a MarkDownTemplate (.mdt) extension.
- OutputBuilder
-
The OutputBuilder converts each Template in the
DocumentationModelinto a GeneratedFile - ParseBuilder
-
Lets the
DocumentationParserparse theDocumentationModel. - ReadMeFile
- A README.md file is typically the first item a visitor will see when visiting your package on https://pub.dev or visiting your code on https://github.com.
- ReadMeTemplate
- ReadMeTemplateFactory
- Template
-
The DocumentationModelBuilder will create the Template for each TemplateFile
The Template will put the contents of the TemplateFile as
TextNodein its children TheDocumentationParserwill replace thisTextNodewith multipleNodes if needed. The OutputBuilder converts each Template into a GeneratedFile - TemplateFile
- TemplateFiles are text files with that can contain:
- WikiFile
- All files in the doc folder that are not a .mdt file (e.g. pictures)
- WikiFileFactory
- Creates DocumentationFiles for all files in the doc folder that are not a .mdt file (e.g. pictures)
- WikiTemplate
- WikiTemplateFactory
- WikiTemplateFile
- Project's that are stored in Github can have wiki pages. Github wiki pages are TemplateFiles. See Github Wiki pages for more information.