options library
Classes
- 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.
- 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 DartdocOptions 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
Enums
- OptionKind
- An enum to specify the multiple different kinds of data an option might represent.
Mixins
Constants
- compileArgsTagName → const String
Functions
-
createDartdocOptions(
PackageMetaProvider packageMetaProvider) → List< DartdocOption< Object?> > - Instantiate dartdoc's configuration file and options parser with the given command line arguments.
-
createDartdocProgramOptions(
PackageMetaProvider packageMetaProvider) → List< DartdocOption< bool> > -
parseOptions(
PackageMetaProvider packageMetaProvider, List< String> arguments, {OptionGenerator? additionalOptions}) → DartdocProgramOptionContext?
Typedefs
-
ConvertYamlToType<
T> = T Function(YamlMap, String, ResourceProvider) -
OptionGenerator
= List<
DartdocOption< Function(PackageMetaProvider)Object?> >