DartdocGeneratorOptionContext class

Helper class that consolidates option contexts for instantiating generators.

Inheritance
Implementers

Constructors

DartdocGeneratorOptionContext(DartdocOptionSet optionSet, Folder dir, ResourceProvider resourceProvider)
DartdocGeneratorOptionContext.fromDefaultContextLocation(DartdocOptionSet optionSet, ResourceProvider resourceProvider)

Properties

allowNonLocalWarnings bool
read-only, inherited
allowTools bool
read-only, inherited
ambiguousReexportScorerMinConfidence double
read-only, inherited
autoIncludeDependencies bool
read-only, inherited
categories CategoryConfiguration
read-only, inherited
categoryOrder List<String>
read-only, inherited
context Folder
read / write, inherited
dropTextFrom List<String>
read-only, inherited
enableExperiment List<String>
read-only, inherited
examplePathPrefix String
read-only, inherited
exclude List<String>
read-only, inherited
excludeFooterVersion bool
read-only, inherited
excludePackages List<String>
read-only, inherited
favicon String
read-only
flutterRoot String
read-only, inherited
Returns the joined contents of any 'footer' files specified in options.
read-only
footerText String
Returns the joined contents of any 'footer-text' files specified in options.
read-only
format String
Output format, e.g. 'html', 'md'
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
Returns the joined contents of any 'header' files specified in options.
read-only
hideSdkText bool
read-only, inherited
include List<String>
read-only, inherited
includeExternal List<String>
read-only, inherited
includeSource bool
read-only, inherited
injectHtml bool
read-only, inherited
inputDir String
read-only, inherited
linkToRemote bool
read-only, inherited
linkToSourceExcludes List<String>
read-only, inherited
linkToSourceRevision String
read-only, inherited
linkToSourceRoot String
read-only, inherited
linkToSourceUriTemplate String
read-only, inherited
linkToUrl String
read-only, inherited
nodoc List<String>
read-only, inherited
optionSet DartdocOptionSet
final, inherited
output String
read-only, inherited
packageMeta PackageMeta
read-only, inherited
packageOrder List<String>
read-only, inherited
packageWarningOptions → PackageWarningOptions
read-only, inherited
prettyIndexJson bool
read-only
relCanonicalPrefix String
read-only
resourceProvider ResourceProvider
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
sdkDir String
read-only, inherited
sdkDocs bool
read-only, inherited
showStats bool
read-only, inherited
showUndocumentedCategories bool
read-only, inherited
templatesDir String
The 'templatesDir' Dartdoc option if one was specified; otherwise null.
read-only
tools ToolConfiguration
read-only, inherited
topLevelPackageMeta PackageMeta
read-only, inherited
useBaseHref bool
read-only, override
useCategories bool
read-only, inherited
read-only, inherited
verboseWarnings bool
read-only, inherited

Methods

isLibraryExcluded(String name) bool
inherited
isPackageExcluded(String name) bool
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() String
A string representation of this object. [...]
inherited

Operators

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