DartdocOptionContext class

An DartdocOptionSet wrapped in nice accessors specific to Dartdoc, which automatically passes in the right directory for a given context.

Usually, a single ModelElement, Package, Category and so forth has a single context and so this can be made a member variable of those structures.

Inheritance
Implementers

Constructors

DartdocOptionContext(DartdocOptionSet optionSet, Resource contextLocation, ResourceProvider resourceProvider)
DartdocOptionContext.fromContext(DartdocOptionContext optionContext, Resource resource, ResourceProvider resourceProvider)
Build a DartdocOptionContext from an existing DartdocOptionContext.
factory
DartdocOptionContext.fromContextElement(DartdocOptionContext optionContext, LibraryElement libraryElement, ResourceProvider resourceProvider)
Build a DartdocOptionContext from an existing DartdocOptionContext and a new analyzer Element.
factory
DartdocOptionContext.fromDefaultContextLocation(DartdocOptionSet optionSet, ResourceProvider resourceProvider)
Build a DartdocOptionContext via the 'inputDir' command line option.
DartdocOptionContext.fromElement(DartdocOptionSet optionSet, LibraryElement libraryElement, ResourceProvider resourceProvider)
Build a DartdocOptionContext from an analyzer element (using its source location).
factory

Properties

allowNonLocalWarnings → bool
no setterinherited
allowTools → bool
no setter
ambiguousReexportScorerMinConfidence → double
no setter
autoIncludeDependencies → bool
no setter
categories → CategoryConfiguration
no setter
categoryOrder → List<String>
no setter
context → Folder
final
enableExperiment → List<String>
no setterinherited
exclude → Set<String>
latefinal
excludeFooterVersion → bool
no setter
flutterRoot → String?
no setter
hashCode → int
The hash code for this object.
no setterinherited
include → Set<String>
latefinal
includeExternal → List<String>
no setter
includeSource → bool
no setter
injectHtml → bool
no setter
inputDir → String
no setter
linkToRemote → bool
no setter
linkToSourceExcludes → List<String>
no setterinherited
linkToSourceRevision → String?
no setterinherited
linkToSourceRoot → String?
no setterinherited
linkToSourceUriTemplate → String?
no setterinherited
linkToUrl → String
no setter
maxFileCount → int
no setter
maxTotalSize → int
no setter
nodoc → List<String>
no setter
optionSet → DartdocOptionSet
final
output → String
no setter
packageMeta → PackageMeta
no setter
packageOrder → List<String>
no setter
packageWarningOptions → PackageWarningOptions
no setterinherited
resourceProvider → ResourceProvider
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sanitizeHtml → bool
no setter
sdkDir → String
no setter
sdkDocs → bool
no setter
showStats → bool
no setter
showUndocumentedCategories → bool
no setter
tools → ToolConfiguration
no setter
topLevelPackageMeta → PackageMeta
no setter
useBaseHref → bool
no setter
useCategories → bool
no setter
no setter
verboseWarnings → bool
no setterinherited

Methods

isLibraryExcluded(String nameOrPath) → bool
isPackageExcluded(String name) → bool
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