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
no setterinherited
allowTools → bool
no setterinherited
ambiguousReexportScorerMinConfidence → double
no setterinherited
autoIncludeDependencies → bool
no setterinherited
categories → CategoryConfiguration
no setterinherited
categoryOrder → List<String>
no setterinherited
context → Folder
finalinherited
dropTextFrom → Set<String>
latefinalinherited
enableExperiment → List<String>
no setterinherited
examplePathPrefix → String?
no setterinherited
exclude → Set<String>
latefinalinherited
excludeFooterVersion → bool
no setterinherited
excludePackages → List<String>
no setterinherited
favicon → String?
no setter
flutterRoot → String?
no setterinherited
Returns the joined contents of any 'footer' files specified in options.
latefinal
footerText → String
Returns the joined contents of any 'footer-text' files specified in options.
latefinal
format → String
Output format, e.g. 'html', 'md'
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
Returns the joined contents of any 'header' files specified in options.
latefinal
hideSdkText → bool
no setterinherited
include → Set<String>
latefinalinherited
includeExternal → List<String>
no setterinherited
includeSource → bool
no setterinherited
injectHtml → bool
no setterinherited
inputDir → String
no setterinherited
linkToRemote → bool
no setterinherited
linkToSourceExcludes → List<String>
no setterinherited
linkToSourceRevision → String?
no setterinherited
linkToSourceRoot → String?
no setterinherited
linkToSourceUriTemplate → String?
no setterinherited
linkToUrl → String
no setterinherited
nodoc → List<String>
no setterinherited
optionSet → DartdocOptionSet
finalinherited
output → String
no setterinherited
packageMeta → PackageMeta
no setterinherited
packageOrder → List<String>
no setterinherited
packageWarningOptions → PackageWarningOptions
no setterinherited
prettyIndexJson → bool
no setter
relCanonicalPrefix → String?
no setter
resourceProvider → ResourceProvider
no setterinherited
resourcesDir → String?
The 'resourcesDir' dartdoc option if one was specified; otherwise null.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sanitizeHtml → bool
no setterinherited
sdkDir → String
no setterinherited
sdkDocs → bool
no setterinherited
showStats → bool
no setterinherited
showUndocumentedCategories → bool
no setterinherited
templatesDir → String?
The 'templatesDir' dartdoc option if one was specified; otherwise null.
no setter
tools → ToolConfiguration
no setterinherited
topLevelPackageMeta → PackageMeta
no setterinherited
useBaseHref → bool
no setteroverride
useCategories → bool
no setterinherited
no setterinherited
verboseWarnings → bool
no setterinherited

Methods

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

Operators

operator ==(Object other) → bool
The equality operator.
inherited