DartdocOptionSet class
A DartdocOption that only contains other DartdocOptions and is not an option itself.
- Inheritance
- Object
- DartdocOption<
void> - DartdocOptionSet
Constructors
- DartdocOptionSet(String name, ResourceProvider resourceProvider)
Properties
- argParser → ArgParser
-
read-only, inherited
- defaultsTo → void
-
This is the value returned if we couldn't find one otherwise.
final, inherited
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- help → String
-
Text string for help passed on in command line options.
final, inherited
- isDir → bool
-
Set to true if this option represents the name of a directory.
read-only, inherited
- isFile → bool
-
Set to true if this option represents the name of a file.
read-only, inherited
- isGlob → bool
-
Set to true if this option represents a glob.
read-only, inherited
-
keys
→ Iterable<
String> -
All object names starting at the root.
read-only, inherited
- mustExist → bool
-
Set to true if DartdocOption subclasses should validate that the
directory or file exists. Does not imply validation of defaultsTo,
and requires that one of isDir or isFile is set.
final, inherited
- name → String
-
The name of this option, not including the names of any parents.
final, inherited
- optionIs → OptionKind
-
final, inherited
-
parent
↔ DartdocOption<
Object> -
The parent of this DartdocOption, or null if this is the root.
read / write, inherited
- resourceProvider → ResourceProvider
-
final, inherited
-
root
→ DartdocOption<
Object> -
The root DartdocOption containing this object, or this if the object
has no parent.
read-only, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
Methods
-
add(
DartdocOption< Object> option) → void -
Adds a DartdocOption to the children of this DartdocOption.
inherited
-
addAll(
Iterable< DartdocOption< options) → voidObject> > -
Adds a list of dartdoc options to the children of this DartdocOption.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
parseArguments(
List< String> arguments) → void -
Call this with argv to set up the argument overrides. Applies to all
children.
inherited
-
toString(
) → String -
A string representation of this object. [...]
inherited
-
traverse(
void visitor(DartdocOption< Object> option)) → void -
Traverse skips this node, because it doesn't represent a real
configuration object.
override
-
valueAt(
Folder dir) → void -
DartdocOptionSet always has the null value.
override
-
valueAtCurrent(
) → void -
Calls valueAt with the working directory at the start of the program.
inherited
-
valueAtElement(
Element element) → void -
Calls valueAt on the directory this element is defined in.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited
-
operator [](
String name) → DartdocOption -
Get the immediate child of this node named
name
.inherited
Static Methods
-
fromOptionGenerators(
String name, Iterable< OptionGenerator> optionGenerators, PackageMetaProvider packageMetaProvider) → Future<DartdocOptionSet> - Asynchronous factory that is the main entry point to initialize Dartdoc options for use. [...]