DartdocGeneratorOptionContext#

Helper class that consolidates option contexts for instantiating generators.

Constructors#

DartdocGeneratorOptionContext()#

DartdocGeneratorOptionContext(
  super.optionSet,
  super.dir,
  super.resourceProvider,
);

DartdocGeneratorOptionContext.fromDefaultContextLocation()#

DartdocGeneratorOptionContext.fromDefaultContextLocation(
  super.optionSet,
  super.resourceProvider,
) : super.fromDefaultContextLocation();

Properties#

allowedIframeHosts no setter inherited#

Inherited from DartdocOptionContext.

List<String> get allowedIframeHosts =>
    optionSet['allowedIframeHosts'].valueAt(context);

allowNonLocalWarnings no setter inherited#

Inherited from PackageWarningOptionContext.

bool get allowNonLocalWarnings =>
    optionSet['allowNonLocalWarnings'].valueAt(context);

allowTools no setter inherited#

Inherited from DartdocOptionContext.

bool get allowTools => optionSet['allowTools'].valueAt(context);

ambiguousReexportScorerMinConfidence no setter inherited#

Inherited from DartdocOptionContext.

double get ambiguousReexportScorerMinConfidence =>
    optionSet['ambiguousReexportScorerMinConfidence'].valueAt(context);

autoIncludeDependencies no setter inherited#

Inherited from DartdocOptionContext.

bool get autoIncludeDependencies =>
    optionSet['autoIncludeDependencies'].valueAt(context);

categories no setter inherited#

Inherited from DartdocOptionContext.

CategoryConfiguration get categories =>
    optionSet['categories'].valueAt(context);

categoryOrder no setter inherited#

Inherited from DartdocOptionContext.

List<String> get categoryOrder => optionSet['categoryOrder'].valueAt(context);

context final inherited#

Inherited from DartdocOptionContext.

@override
final Folder context;

enableExperiment no setter inherited#

Inherited from DartdocExperimentOptionContext.

List<String> get enableExperiment =>
    optionSet['enable-experiment'].valueAt(context);

exclude late final inherited#

Inherited from DartdocOptionContext.

late final Set<String> exclude = docs_recipe
    .resolveExcludedLibrariesForRecipe(
      recipe,
      fallback: Set.of(optionSet['exclude'].valueAt(context)),
      resourceProvider: resourceProvider,
      inputDir: inputDir,
      packageName: topLevelPackageMeta.name,
    );

excludeFooterVersion no setter inherited#

Inherited from DartdocOptionContext.

bool get excludeFooterVersion =>
    optionSet['excludeFooterVersion'].valueAt(context);

favicon no setter#

String? get favicon => optionSet['favicon'].valueAt(context);

flutterRoot no setter inherited#

Inherited from DartdocOptionContext.

String? get flutterRoot => optionSet['flutterRoot'].valueAt(context);

footer no setter#

The joined contents of any 'footer' files specified in options.

String get footer =>
    _joinCustomTextFiles(optionSet['footer'].valueAt(context));

footerText no setter#

The joined contents of any 'footer-text' files specified in options.

String get footerText =>
    _joinCustomTextFiles(optionSet['footerText'].valueAt(context));

format no setter inherited#

Inherited from DartdocOptionContext.

String get format => optionSet['format'].valueAt(context);

generateDocs no setter#

Whether to generate docs or perform a dry run.

bool get generateDocs => optionSet['generateDocs'].valueAt(context);

guideDirs no setter inherited#

Inherited from DartdocOptionContext.

List<String> get guideDirs => docs_recipe.resolveGuideDirsForRecipe(
  recipe,
  fallback: optionSet['guide']['dirs'].valueAt(context),
);

guideExclude no setter inherited#

Inherited from DartdocOptionContext.

List<String> get guideExclude => docs_recipe.resolveGuideExcludeForRecipe(
  recipe,
  fallback: optionSet['guide']['exclude'].valueAt(context),
);

guideInclude no setter inherited#

Inherited from DartdocOptionContext.

List<String> get guideInclude =>
    optionSet['guide']['include'].valueAt(context);

hashCode no setter inherited#

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

external int get hashCode;

header no setter#

The joined contents of any 'header' files specified in options.

String get header =>
    _joinCustomTextFiles(optionSet['header'].valueAt(context));

include late final inherited#

Inherited from DartdocOptionContext.

late final Set<String> include = Set.of(
  optionSet['include'].valueAt(context),
);

includePackages no setter inherited#

Inherited from DartdocOptionContext.

List<String> get includePackages =>
    optionSet['includePackages'].valueAt(context);

includeSource no setter inherited#

Inherited from DartdocOptionContext.

bool get includeSource => optionSet['includeSource'].valueAt(context);

injectHtml no setter inherited#

Inherited from DartdocOptionContext.

bool get injectHtml => optionSet['injectHtml'].valueAt(context);

inputDir no setter inherited#

Inherited from DartdocOptionContext.

String get inputDir => optionSet['inputDir'].valueAt(context);

linkToRemote no setter inherited#

Inherited from DartdocOptionContext.

bool get linkToRemote => optionSet['linkTo']['remote'].valueAt(context);

linkToSourceExcludes no setter inherited#

Inherited from SourceLinkerOptionContext.

List<String> get linkToSourceExcludes =>
    optionSet['linkToSource']['excludes'].valueAt(context);

linkToSourceRevision no setter inherited#

Inherited from SourceLinkerOptionContext.

String? get linkToSourceRevision =>
    optionSet['linkToSource']['revision'].valueAt(context);

linkToSourceRoot no setter inherited#

Inherited from SourceLinkerOptionContext.

String? get linkToSourceRoot =>
    optionSet['linkToSource']['root'].valueAt(context);

linkToSourceUriTemplate no setter inherited#

Inherited from SourceLinkerOptionContext.

String? get linkToSourceUriTemplate =>
    optionSet['linkToSource']['uriTemplate'].valueAt(context);

linkToUrl no setter inherited#

Inherited from DartdocOptionContext.

String get linkToUrl => optionSet['linkTo']['url'].valueAt(context);

maxFileCount no setter inherited#

Inherited from DartdocOptionContext.

int get maxFileCount =>
    int.parse(optionSet['maxFileCount'].valueAt(context) ?? '0');

maxTotalSize no setter inherited#

Inherited from DartdocOptionContext.

int get maxTotalSize =>
    int.parse(optionSet['maxTotalSize'].valueAt(context) ?? '0');

optionSet final inherited#

Inherited from DartdocOptionContext.

@override
final DartdocOptionSet optionSet;

output no setter inherited#

Inherited from DartdocOptionContext.

String get output => optionSet['output'].valueAt(context);

packageMeta no setter inherited#

Inherited from DartdocOptionContext.

PackageMeta get packageMeta => optionSet['packageMeta'].valueAt(context);

packageOrder no setter inherited#

Inherited from DartdocOptionContext.

List<String> get packageOrder => optionSet['packageOrder'].valueAt(context);

packageWarningOptions no setter inherited#

Inherited from PackageWarningOptionContext.

PackageWarningOptions get packageWarningOptions =>
    optionSet['packageWarningOptions'].valueAt(context);

prettyIndexJson no setter#

bool get prettyIndexJson => optionSet['prettyIndexJson'].valueAt(context);

recipe no setter inherited#

Inherited from DartdocOptionContext.

String? get recipe => optionSet['recipe'].valueAt(context);

relCanonicalPrefix no setter#

String? get relCanonicalPrefix =>
    optionSet['relCanonicalPrefix'].valueAt(context);

resourceProvider no setter inherited#

Inherited from DartdocOptionContext.

ResourceProvider get resourceProvider => optionSet.resourceProvider;

resourcesDir no setter#

String? get resourcesDir => optionSet['resourcesDir'].valueAt(context);

runtimeType no setter inherited#

A representation of the runtime type of the object.

Inherited from Object.

external Type get runtimeType;

sanitizeHtml no setter inherited#

Inherited from DartdocOptionContext.

bool get sanitizeHtml => optionSet['sanitizeHtml'].valueAt(context);

sdkDir no setter inherited#

Inherited from DartdocOptionContext.

String get sdkDir => optionSet['sdkDir'].valueAt(context);

sdkDocs no setter inherited#

Inherited from DartdocOptionContext.

bool get sdkDocs => optionSet['sdkDocs'].valueAt(context);

showStats no setter inherited#

Inherited from DartdocOptionContext.

bool get showStats => optionSet['showStats'].valueAt(context);

showUndocumentedCategories no setter inherited#

Inherited from DartdocOptionContext.

bool get showUndocumentedCategories =>
    optionSet['showUndocumentedCategories'].valueAt(context);

tools no setter inherited#

Inherited from DartdocOptionContext.

ToolConfiguration get tools => optionSet['tools'].valueAt(context);

topLevelPackageMeta no setter inherited#

Inherited from DartdocOptionContext.

PackageMeta get topLevelPackageMeta =>
    optionSet['topLevelPackageMeta'].valueAt(context);

useBaseHref no setter override#

@override
bool get useBaseHref => optionSet['useBaseHref'].valueAt(context);

validateLinks no setter inherited#

Inherited from DartdocOptionContext.

bool get validateLinks => optionSet['validateLinks'].valueAt(context);

verboseWarnings no setter inherited#

Inherited from PackageWarningOptionContext.

bool get verboseWarnings => optionSet['verboseWarnings'].valueAt(context);

workspaceDocs no setter inherited#

Inherited from DartdocOptionContext.

bool get workspaceDocs => optionSet['workspaceDocs'].valueAt(context);

Methods#

isLibraryExcluded() inherited#

Inherited from DartdocOptionContext.

bool isLibraryExcluded(String nameOrPath) => exclude.contains(nameOrPath);

isPackageExcluded() inherited#

Inherited from DartdocOptionContext.

bool isPackageExcluded(String name) => _excludePackages.contains(name);

noSuchMethod() inherited#

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

toString() inherited#

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

external String toString();

Operators#

operator ==() inherited#

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

external bool operator ==(Object other);