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
- Object
- DartdocOptionContextBase
- DartdocOptionContext
- Implementers
Constructors
- DartdocOptionContext(DartdocOptionSet optionSet, Resource resource, ResourceProvider resourceProvider)
-
If
entity
is null, assume this is the initialization case and use the inputDir flag to determine the context. - 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.fromElement(DartdocOptionSet optionSet, LibraryElement libraryElement, ResourceProvider resourceProvider)
-
Build a DartdocOptionContext from an analyzer element (using its source
location).
factory
Properties
- allowNonLocalWarnings → bool
-
read-only, inherited
- allowTools → bool
-
read-only
- ambiguousReexportScorerMinConfidence → double
-
read-only
- autoIncludeDependencies → bool
-
read-only
- categories → CategoryConfiguration
-
read-only
-
categoryOrder
→ List<
String> -
read-only
- context ↔ Folder
-
read / write, override-getter
-
dropTextFrom
→ List<
String> -
read-only
-
enableExperiment
→ List<
String> -
read-only, inherited
- examplePathPrefix → String
-
read-only
-
exclude
→ List<
String> -
read-only
-
read-only
-
excludePackages
→ List<
String> -
read-only
- flutterRoot → String
-
read-only
- format → String
-
Output format, e.g. 'html', 'md'
read-only
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- hideSdkText → bool
-
read-only
-
include
→ List<
String> -
read-only
-
includeExternal
→ List<
String> -
read-only
- includeSource → bool
-
read-only
- injectHtml → bool
-
read-only
- inputDir → String
-
read-only
- linkToRemote → bool
-
read-only
-
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
-
nodoc
→ List<
String> -
read-only
- optionSet → DartdocOptionSet
-
final
- output → String
-
read-only
- packageMeta → PackageMeta
-
read-only
-
packageOrder
→ List<
String> -
read-only
- packageWarningOptions → PackageWarningOptions
-
read-only, inherited
- resourceProvider → ResourceProvider
-
read-only
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- sdkDir → String
-
read-only
- sdkDocs → bool
-
read-only
- showUndocumentedCategories → bool
-
read-only
- tools → ToolConfiguration
-
read-only
- topLevelPackageMeta → PackageMeta
-
read-only
- useBaseHref → bool
-
read-only
- useCategories → bool
-
read-only
- validateLinks → bool
-
read-only
- verboseWarnings → bool
-
read-only, inherited
Methods
-
isLibraryExcluded(
String name) → bool -
isPackageExcluded(
String name) → bool -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toString(
) → String -
Returns a string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited