dartdoc#

A documentation generator for Dart.

Classes#

Class	Description
CategoryConfiguration	A configuration class that can interpret category definitions from a YAML map.
CategoryDefinition	Defines the attributes of a category in the options file, corresponding to the 'categories' keyword in the options file, and populated by the CategoryConfiguration class.
ConstructedModelElementsKey
Dartdoc	Generates Dart documentation for all public Dart libraries in the given directory.
DartdocFileWriter
DartdocGeneratorOptionContext	Helper class that consolidates option contexts for instantiating generators.
DartdocOption<T extends Object?>	An abstract class for interacting with dartdoc options.
DartdocOptionArgFile<T>	A DartdocOption that works with command line arguments and `dartdoc_options` files.
DartdocOptionArgOnly<T>	A DartdocOption that only exists as a command line argument. `--help` is a good example.
DartdocOptionArgSynth<T>	A class that defaults to a value computed from a closure, but can be overridden on the command line.
DartdocOptionContext	An DartdocOptionSet wrapped in nice accessors specific to Dartdoc, which automatically passes in the right directory for a given context.
DartdocOptionContextBase	All DartdocOptionContext mixins should implement this, as well as any other DartdocOptionContext mixins they use for calculating synthetic options.
DartdocOptionFileOnly<T>
DartdocOptionFileSynth<T>	A class that defaults to a value computed from a closure, but can be overridden by a file.
DartdocOptionRoot	This is a DartdocOptionSet used as a root node.
DartdocOptionSet	A DartdocOption that only contains other DartdocOption s and is not an option itself.
DartdocOptionSyntheticOnly<T>	A synthetic option takes a closure at construction time that computes the value of the configuration option based on other configuration options. Does not protect against closures that self-reference. If mustExist and isDir or isFile is set, computed values will be resolved to canonical paths.
DartdocProgramOptionContext
DartDocResolvedLibrary	Contains the ResolvedLibraryResult and any additional information about the library.
DartdocResults	The results of a Dartdoc.generateDocs call.
FileWriter
Generator	A generator generates documentation for a given package.
InheritableElementsKey
NoFileWriter	Used for the generateDocs:false option.
PackageBuilder	Everything you need to instantiate a PackageGraph object for documenting.
PackageGraph
PackageMeta	Describes a single package in the context of `dartdoc`.
PackageMetaProvider	Sets the supported way of constructing PackageMeta objects.
PubPackageBuilder	A package builder that understands pub package format.
PubPackageMeta	Default implementation of PackageMeta depends on pub packages.

Exceptions#

Exception
DartdocFileMissing
DartdocOptionError
PackageMetaFailure

Enums#

Enum	Description
Kind
OptionKind	An enum to specify the multiple different kinds of data an option might represent.

Mixins#

Mixin
DartdocSyntheticOption<T>

Functions#

Function	Description
clearPackageMetaCache
createDartdocOptions	Instantiate dartdoc's configuration file and options parser with the given command line arguments.
createDartdocProgramOptions
createGeneratorOptions
findPackageConfig	Discovers the package configuration for a Dart script.
findPackageConfigInDirectory	Finds a `.dart_tool/package_config.json` file in `folder`.
initHtmlGenerator	Creates a Generator with an `HtmlGeneratorBackend` backend.
initJasprGenerator	Creates a Generator with a `JasprGeneratorBackend` backend.
initVitePressGenerator	Creates a Generator with a `VitePressGeneratorBackend` backend.
parseOptions

Properties#

Property
pubPackageMetaProvider

Constants#

Constant
compileArgsTagName
dartdocVersion
programName

Typedefs#

Typedef
ConvertYamlToType<T>
OptionGenerator