DartdocGeneratorOptionContext class

Helper class that consolidates option contexts for instantiating generators.

Inheritance
Implementers

Constructors

DartdocGeneratorOptionContext(DartdocOptionSet optionSet, Resource 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
enableExperiment List<String>
no setterinherited
exclude Set<String>
latefinalinherited
excludeFooterVersion bool
no setterinherited
favicon String?
no setter
flutterRoot String?
no setterinherited
The joined contents of any 'footer' files specified in options.
no setter
footerText String
The joined contents of any 'footer-text' files specified in options.
no setter
hashCode int
The hash code for this object.
no setterinherited
The joined contents of any 'header' files specified in options.
no setter
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
maxFileCount int
no setterinherited
maxTotalSize int
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?
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?
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 nameOrPath) 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