TopLevelVariable class
Top-level variables. But also picks up getters and setters?
- Inheritance
- Object
- Canonicalization
- ModelElement
- TopLevelVariable
- Implemented types
- Mixed in types
Constructors
- TopLevelVariable(TopLevelVariableElement element, Library library, PackageGraph packageGraph, Accessor getter, Accessor setter)
Properties
-
allAccessors
→ Iterable<
Accessor> -
read-only, inherited
-
allParameters
→ List<
Parameter> -
read-only, inherited
-
annotations
→ List<
String> -
read-only, inherited
- arrow → String
-
read-only, inherited
- canHaveParameters → bool
-
read-only, inherited
- canonicalLibrary → Library
-
read-only, inherited
- canonicalModelElement → ModelElement
-
read-only, inherited
-
categories
→ Iterable<
Category> -
read-only, inherited
-
categoryNames
→ List<
String> -
Either a set of strings containing all declared categories for this symbol,
or a set containing Null if none were declared.
read-only, inherited
- characterLocation → CharacterLocation
-
read-only, inherited
-
comboFeatures
→ Set<
String> -
read-only, inherited
-
commentRefs
→ List<
ModelCommentReference> -
read-only, inherited
- compilationUnitElement → CompilationUnitElement
-
read-only, inherited
-
computeDocumentationFrom
→ List<
ModelElement> -
Returns the ModelElement(s) from which we will get documentation.
Can be more than one if this is a Field composing documentation from
multiple Accessors. [...]
read-only, inherited
- config → DartdocOptionContext
-
read-only, inherited
- constantInitializer → Expression
-
read-only, inherited
- constantValue → String
-
read-only, inherited
- constantValueBase → String
-
read-only, inherited
- constantValueTruncated → String
-
read-only, inherited
- definingLibrary → Library
-
read-only, inherited
-
displayedCategories
→ Iterable<
Category> -
read-only, inherited
-
displayedLanguageFeatures
→ Iterable<
LanguageFeature> -
A list of language features that both apply to this ModelElement and
make sense to display in context.
read-only, inherited
- documentation → String
-
Returns the docs, stripped of their leading comments syntax.
read-only, override
- documentationAsHtml → String
-
read-only, inherited
- documentationComment → String
-
read-only, inherited
-
documentationFrom
→ List<
ModelElement> -
read-only, inherited
- documentationIsLocal → bool
-
True if documentationFrom contains only one item, this.
read-only, inherited
- documentationLocal → String
-
read-only, inherited
- element → Element
-
read-only, inherited
- enclosingElement ↔ ModelElement
-
read / write, inherited-setter
-
exportedInLibraries
→ Set<
Library> -
read-only, inherited
- extendedDocLink → String
-
Returns a link to extended documentation, or the empty string if that
does not exist.
read-only, inherited
-
features
→ Set<
String> -
read-only, override
- featuresAsString → String
-
read-only, inherited
- fileName → String
-
read-only, override
- filePath → String
-
read-only, override
- fileType → String
-
read-only, inherited
- fullyQualifiedName → String
-
Returns the fully qualified name. [...]
read-only, inherited
- fullyQualifiedNameWithoutLibrary → String
-
read-only, inherited
- getter → Accessor
-
final
- getterSetterBothAvailable → bool
-
read-only, inherited
- getterSetterDocumentationComment → String
-
read-only, inherited
- hasAccessorsWithDocs → bool
-
read-only, inherited
- hasAnnotations → bool
-
read-only, inherited
- hasCategorization → bool
-
True if categories, subcategories, a documentation icon, or samples were
declared.
read-only, inherited
- hasCategoryNames → bool
-
read-only, inherited
- hasDisplayedCategories → bool
-
read-only, inherited
- hasDocumentation → bool
-
read-only, inherited
- hasExplicitGetter → bool
-
read-only, inherited
- hasExplicitSetter → bool
-
read-only, inherited
- hasExtendedDocumentation → bool
-
read-only, inherited
- hasFeatureSet → bool
-
read-only, inherited
- hasGetter → bool
-
read-only, inherited
- hasGetterOrSetter → bool
-
read-only, inherited
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- hasImage → bool
-
read-only, inherited
- hasNodoc → bool
-
Returns true if the raw documentation comment has a nodoc indication.
read-only, inherited
- hasNoGetterSetter → bool
-
read-only, inherited
- hasParameters → bool
-
read-only, inherited
- hasPublicGetter → bool
-
read-only, inherited
- hasPublicGetterNoSetter → bool
-
read-only, inherited
- hasPublicSetter → bool
-
read-only, inherited
- hasSamples → bool
-
read-only, inherited
- hasSetter → bool
-
read-only, inherited
- hasSourceCode → bool
-
read-only, inherited
- hasSourceHref → bool
-
read-only, inherited
- hasSubCategoryNames → bool
-
read-only, inherited
- href → String
-
If canonicalLibrary (or canonicalEnclosingElement, for Inheritable
subclasses) is null, href should be null.
read-only, override
- htmlId → String
-
read-only, inherited
- image → String
-
Either a URI to a defined image, or the empty string if none
was declared.
read-only, inherited
- isAsynchronous → bool
-
read-only, inherited
- isCanonical → bool
-
read-only, inherited
- isConst → bool
-
read-only, override
- isDeprecated → bool
-
read-only, inherited
- isDocumented → bool
-
read-only, inherited
- isExecutable → bool
-
read-only, inherited
- isFinal → bool
-
read-only, override
- isInherited → bool
-
read-only, override
- isLate → bool
-
read-only, override
- isLocalElement → bool
-
read-only, inherited
- isNullSafety → bool
-
read-only, inherited
- isPropertyAccessor → bool
-
read-only, inherited
- isPropertyInducer → bool
-
read-only, inherited
- isPublic → bool
-
read-only, inherited
- isPublicAndPackageDocumented → bool
-
read-only, inherited
- isStatic → bool
-
read-only, inherited
- kind → String
-
A human-friendly name for the kind of element this is.
read-only, override
- library → Library
-
read-only, inherited
- linkedName → String
-
read-only, inherited
- linkedParams → String
-
read-only, inherited
- linkedParamsLines → String
-
read-only, inherited
- linkedParamsNoMetadata → String
-
read-only, inherited
- linkedParamsNoMetadataOrNames → String
-
read-only, inherited
- linkedReturnType → String
-
read-only, inherited
- location → String
-
A string indicating the URI of this Locatable, usually derived from
Element.location.
read-only, inherited
-
locationPieces
→ Set<
String> -
Pieces of the location, split to remove 'package:' and slashes.
read-only, inherited
- modelElementRenderer → ModelElementRenderer
-
@visibleForTesting, read-only, inherited
- modelNode → ModelNode
-
read-only, inherited
- modelType → DefinedElementType
-
read-only, override
- name → String
-
read-only, inherited
- namePart → String
-
Utility getter/cache for
_MarkdownCommentReference._getResultsForClass
.read-only, inherited -
namePieces
→ Set<
String> -
read-only, inherited
- oneLineDoc → String
-
read-only, inherited
- originalMember → Member
-
read-only, inherited
- overriddenDepth → int
-
read-only, inherited
- package → Package
-
read-only, inherited
- packageGraph → PackageGraph
-
read-only, inherited
-
parameters
→ List<
Parameter> -
read-only, inherited
- pathContext → Context
-
read-only, inherited
- readOnly → bool
-
read-only, inherited
- readWrite → bool
-
read-only, inherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- samples → String
-
Either a URI to documentation with samples, or the empty string if none
was declared.
read-only, inherited
- setter → Accessor
-
final
- sourceCode → String
-
read-only, inherited
- sourceFileName → String
-
read-only, inherited
- sourceHref → String
-
read-only, inherited
-
subCategoryNames
→ List<
String> -
Either a set of strings containing all declared subcategories for this symbol,
or a set containing Null if none were declared.
read-only, inherited
- writeOnly → bool
-
read-only, inherited
Methods
-
annotationsFromMetadata(
Iterable< ElementAnnotation> md) → List<String> -
Returns linked annotations from a given metadata set, with escaping.
inherited
-
buildCanonicalModelElement(
) → ModelElement -
inherited
-
buildDocumentationAddition(
String rawDocs) → String -
Override this to add more features to the documentation builder in a
subclass.
inherited
-
compareTo(
dynamic other) → int -
Compares this object to another object. [...]
inherited
-
computeDocumentationComment(
) → String -
Implement to derive the raw documentation comment string from the
analyzer.
override
-
linkifyConstantValue(
String original) → String -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
precacheLocalDocs(
) → Future< void> -
Unconditionally precache local documentation. [...]
inherited
-
processComment(
String documentationComment) → Future< String> -
Process
documentationComment
, performing various actions based on{@}
-style directives, returning the processed result.inherited -
processCommentDirectives(
String docs) → String -
inherited
-
processCommentWithoutTools(
String documentationComment) → String -
Process a
documentationComment
, performing various actions based on{@}
-style directives, except{@tool}
, returning the processed result.inherited -
scoreCanonicalCandidates(
Iterable< Library> libraries) → List<ScoredCandidate> -
inherited
-
scoreElementWithLibrary(
Library lib) → ScoredCandidate -
@Deprecated('Public method intended to be private; will be removed as early as ' 'Dartdoc 1.0.0'), inherited
-
setModelType(
ElementType type) → void -
inherited
-
toString(
) → String -
A string representation of this object. [...]
inherited
-
warn(
PackageWarning kind, {String message, Iterable< Locatable> referredFrom, Iterable<String> extendedDebug}) → void -
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited