DartdocProgramOptionContext

classDartdocProgramOptionContextextendsDartdocGeneratorOptionContext

Inheritance

Object → DartdocOptionContextBase → DartdocOptionContext → DartdocGeneratorOptionContext → DartdocProgramOptionContext

Constructors

DartdocProgramOptionContext()

DartdocProgramOptionContext(DartdocOptionSetoptionSet,Resourcedir,ResourceProviderresourceProvider,);

Implementation

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

DartdocProgramOptionContext.fromDefaultContextLocation()

DartdocProgramOptionContext.fromDefaultContextLocation(DartdocOptionSetoptionSet,ResourceProviderresourceProvider,);

Implementation

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

Properties

allowedIframeHosts no setter inherited

List<String>getallowedIframeHosts

Inherited from DartdocOptionContext.

Implementation

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

allowNonLocalWarnings no setter inherited

boolgetallowNonLocalWarnings

Inherited from PackageWarningOptionContext.

Implementation

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

allowTools no setter inherited

boolgetallowTools

Inherited from DartdocOptionContext.

Implementation

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

ambiguousReexportScorerMinConfidence no setter inherited

doublegetambiguousReexportScorerMinConfidence

Inherited from DartdocOptionContext.

Implementation

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

autoIncludeDependencies no setter inherited

boolgetautoIncludeDependencies

Inherited from DartdocOptionContext.

Implementation

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

categories no setter inherited

CategoryConfigurationgetcategories

Inherited from DartdocOptionContext.

Implementation

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

categoryOrder no setter inherited

List<String>getcategoryOrder

Inherited from DartdocOptionContext.

Implementation

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

context final inherited

finalFoldercontext

Inherited from DartdocOptionContext.

Implementation

@override
final Folder context;

enableExperiment no setter inherited

List<String>getenableExperiment

Inherited from DartdocExperimentOptionContext.

Implementation

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

exclude late final inherited

finallateSet<String>exclude

Inherited from DartdocOptionContext.

Implementation

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

boolgetexcludeFooterVersion

Inherited from DartdocOptionContext.

Implementation

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

favicon no setter inherited

String?getfavicon

Inherited from DartdocGeneratorOptionContext.

Implementation

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

flutterRoot no setter inherited

String?getflutterRoot

Inherited from DartdocOptionContext.

Implementation

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

footer no setter inherited

Stringgetfooter

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

Inherited from DartdocGeneratorOptionContext.

Implementation

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

footerText no setter inherited

StringgetfooterText

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

Inherited from DartdocGeneratorOptionContext.

Implementation

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

format no setter inherited

Stringgetformat

Inherited from DartdocOptionContext.

Implementation

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

generateDocs no setter inherited

boolgetgenerateDocs

Whether to generate docs or perform a dry run.

Inherited from DartdocGeneratorOptionContext.

Implementation

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

guideDirs no setter inherited

List<String>getguideDirs

Inherited from DartdocOptionContext.

Implementation

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

guideExclude no setter inherited

List<String>getguideExclude

Inherited from DartdocOptionContext.

Implementation

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

guideInclude no setter inherited

List<String>getguideInclude

Inherited from DartdocOptionContext.

Implementation

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

hashCode no setter inherited

intgethashCode

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.

Implementation

external int get hashCode;

header no setter inherited

Stringgetheader

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

Inherited from DartdocGeneratorOptionContext.

Implementation

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

include late final inherited

finallateSet<String>include

Inherited from DartdocOptionContext.

Implementation

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

includePackages no setter inherited

List<String>getincludePackages

Inherited from DartdocOptionContext.

Implementation

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

includeSource no setter inherited

boolgetincludeSource

Inherited from DartdocOptionContext.

Implementation

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

injectHtml no setter inherited

boolgetinjectHtml

Inherited from DartdocOptionContext.

Implementation

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

inputDir no setter inherited

StringgetinputDir

Inherited from DartdocOptionContext.

Implementation

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

json no setter inherited

boolgetjson

Inherited from LoggingContext.

Implementation

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

linkToRemote no setter inherited

boolgetlinkToRemote

Inherited from DartdocOptionContext.

Implementation

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

linkToSourceExcludes no setter inherited

List<String>getlinkToSourceExcludes

Inherited from SourceLinkerOptionContext.

Implementation

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

linkToSourceRevision no setter inherited

String?getlinkToSourceRevision

Inherited from SourceLinkerOptionContext.

Implementation

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

linkToSourceRoot no setter inherited

String?getlinkToSourceRoot

Inherited from SourceLinkerOptionContext.

Implementation

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

linkToSourceUriTemplate no setter inherited

String?getlinkToSourceUriTemplate

Inherited from SourceLinkerOptionContext.

Implementation

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

linkToUrl no setter inherited

StringgetlinkToUrl

Inherited from DartdocOptionContext.

Implementation

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

maxFileCount no setter inherited

intgetmaxFileCount

Inherited from DartdocOptionContext.

Implementation

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

maxTotalSize no setter inherited

intgetmaxTotalSize

Inherited from DartdocOptionContext.

Implementation

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

optionSet final inherited

finalDartdocOptionSetoptionSet

Inherited from DartdocOptionContext.

Implementation

@override
final DartdocOptionSet optionSet;

output no setter inherited

Stringgetoutput

Inherited from DartdocOptionContext.

Implementation

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

packageMeta no setter inherited

PackageMetagetpackageMeta

Inherited from DartdocOptionContext.

Implementation

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

packageOrder no setter inherited

List<String>getpackageOrder

Inherited from DartdocOptionContext.

Implementation

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

packageWarningOptions no setter inherited

PackageWarningOptionsgetpackageWarningOptions

Inherited from PackageWarningOptionContext.

Implementation

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

prettyIndexJson no setter inherited

boolgetprettyIndexJson

Inherited from DartdocGeneratorOptionContext.

Implementation

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

quiet no setter inherited

boolgetquiet

Inherited from LoggingContext.

Implementation

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

recipe no setter inherited

String?getrecipe

Inherited from DartdocOptionContext.

Implementation

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

relCanonicalPrefix no setter inherited

String?getrelCanonicalPrefix

Inherited from DartdocGeneratorOptionContext.

Implementation

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

resourceProvider no setter inherited

ResourceProvidergetresourceProvider

Inherited from DartdocOptionContext.

Implementation

ResourceProvider get resourceProvider => optionSet.resourceProvider;

resourcesDir no setter inherited

String?getresourcesDir

Inherited from DartdocGeneratorOptionContext.

Implementation

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

runtimeType no setter inherited

TypegetruntimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

external Type get runtimeType;

sanitizeHtml no setter inherited

boolgetsanitizeHtml

Inherited from DartdocOptionContext.

Implementation

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

sdkDir no setter inherited

StringgetsdkDir

Inherited from DartdocOptionContext.

Implementation

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

sdkDocs no setter inherited

boolgetsdkDocs

Inherited from DartdocOptionContext.

Implementation

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

showProgress no setter inherited

boolgetshowProgress

Inherited from LoggingContext.

Implementation

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

showStats no setter inherited

boolgetshowStats

Inherited from DartdocOptionContext.

Implementation

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

showUndocumentedCategories no setter inherited

boolgetshowUndocumentedCategories

Inherited from DartdocOptionContext.

Implementation

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

tools no setter inherited

ToolConfigurationgettools

Inherited from DartdocOptionContext.

Implementation

ToolConfiguration get tools => allowTools
    ? optionSet['tools'].valueAt(context)
    : ToolConfiguration.empty(resourceProvider);

topLevelPackageMeta no setter inherited

PackageMetagettopLevelPackageMeta

Inherited from DartdocOptionContext.

Implementation

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

useBaseHref no setter inherited

boolgetuseBaseHref

Inherited from DartdocGeneratorOptionContext.

Implementation

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

validateLinks no setter inherited

boolgetvalidateLinks

Inherited from DartdocOptionContext.

Implementation

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

verboseWarnings no setter inherited

boolgetverboseWarnings

Inherited from PackageWarningOptionContext.

Implementation

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

workspaceDocs no setter inherited

boolgetworkspaceDocs

Inherited from DartdocOptionContext.

Implementation

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

Methods

isLibraryExcluded() inherited

boolisLibraryExcluded(StringnameOrPath)

Inherited from DartdocOptionContext.

Implementation

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

isPackageExcluded() inherited

boolisPackageExcluded(Stringname)

Inherited from DartdocOptionContext.

Implementation

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

noSuchMethod() inherited

dynamicnoSuchMethod(Invocationinvocation)

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.

Implementation

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

toString() inherited

StringtoString()

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.

Implementation

external String toString();

Operators

operator ==() inherited

booloperator ==(Objectother)

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.

Implementation

external bool operator ==(Object other);