Inheritance
Implemented types
Mixed in types
Implementers
Properties
aliasedType
→ DartType
no setter
allParameters
→ List <Parameter >
late final inherited
annotations
→ Iterable <Annotation >
late final inherited
asCallable
→ FunctionTypedef
Helper for mustache templates, which can't do casting themselves
without this.
no setter
canonicalLibrary
→ Library ?
late final inherited
canonicalModelElement
→ ModelElement ?
late final inherited
categories
→ Iterable <Category >
late final inherited
categoryNames
→ List <String > ?
Either a set of strings containing all declared categories for this symbol,
or 'null' if none were declared.
no setter inherited
characterLocation
→ CharacterLocation?
late final inherited
compilationUnitElement
→ CompilationUnitElement?
no setter inherited
config
→ DartdocOptionContext
late final inherited
For testing / comparison only, get the comment referable from where this
ElementType was defined. Override where an Element
is available.
no setter inherited
definingLibrary
→ Library
no setter inherited
displayedCategories
→ Iterable <Category >
no setter inherited
displayedLanguageFeatures
→ Iterable <LanguageFeature >
A list of language features that both apply to this ModelElement and
make sense to display in context.
no setter inherited
documentation
→ String
Returns the docs, stripped of their leading comments syntax.
no setter inherited
documentationAsHtml
→ String ?
late final inherited
The rawest form of the documentation comment, including comment delimiters
like ///
, //
, /*
, */
.
no setter inherited
documentationFrom
→ List <DocumentationComment >
The ModelElement from which we will get documentation.
no setter inherited
documentationIsLocal
→ bool
True if documentationFrom contains only one item, this .
no setter inherited
documentationLocal
→ String ?
no setter inherited
element
→ TypeAliasElement?
no setter override
elementDocumentation
→ Documentation
late final inherited
enclosingElement
→ Library ?
no setter
exportedInLibraries
→ Set <Library > ?
no setter inherited
features
→ Set <Feature >
Usually a superset of annotations except where _specialFeatures
replace them, a list of annotations as well as tags applied by
Dartdoc itself when it notices characteristics of an element
that need to be documented. See Feature
for a list.
no setter inherited
featuresAsString
→ String
no setter inherited
fileName
→ String
no setter inherited
filePath
→ String
no setter override
fileType
→ String
no setter inherited
fullyQualifiedName
→ String
Returns the fully qualified name.
late final inherited
fullyQualifiedNameWithoutLibrary
→ String
no setter inherited
genericParameters
→ String
no setter override
hasAnnotations
→ bool
no setter inherited
hasCategorization
→ bool
True if categories, subcategories, a documentation icon, or samples were
declared.
late final inherited
hasCategoryNames
→ bool
no setter inherited
hasDocumentation
→ bool
no setter inherited
True if this has a synthetic/inherited or local documentation
comment. False otherwise.
no setter inherited
hasFeatures
→ bool
no setter inherited
hasFeatureSet
→ bool
no setter inherited
hasGenericParameters
→ bool
no setter inherited
hashCode
→ int
The hash code for this object.
no setter inherited
hasImage
→ bool
no setter inherited
hasNodoc
→ bool
Returns true if the raw documentation comment has a 'nodoc' indication.
late final inherited
hasParameters
→ bool
no setter inherited
hasSamples
→ bool
no setter inherited
hasSourceCode
→ bool
no setter inherited
hasSourceHref
→ bool
no setter inherited
hasSubCategoryNames
→ bool
no setter inherited
href
→ String ?
If canonicalLibrary (or canonicalEnclosingElement, for Inheritable
subclasses) is null, href should be null.
no setter override
htmlId
→ String
no setter inherited
image
→ String ?
Either a URI to a defined image,
or 'null' if one was not declared.
no setter inherited
isAsynchronous
→ bool
no setter inherited
isCallable
→ bool
no setter inherited
isCanonical
→ bool
no setter inherited
isConst
→ bool
no setter inherited
isDeprecated
→ bool
no setter inherited
isDocumented
→ bool
no setter inherited
isEnumValue
→ bool
Whether this element is an enum value.
no setter inherited
isExecutable
→ bool
no setter inherited
isFinal
→ bool
no setter inherited
isInherited
→ bool
no setter
isLate
→ bool
no setter inherited
isLocalElement
→ bool
no setter inherited
isNullSafety
→ bool
no setter inherited
isPropertyAccessor
→ bool
no setter inherited
isPropertyInducer
→ bool
no setter inherited
isPublic
→ bool
late final inherited
isPublicAndPackageDocumented
→ bool
no setter inherited
isStatic
→ bool
no setter inherited
kind
→ String
A human-friendly name for the kind of element this is.
no setter override
library
→ Library
no setter override
linkedGenericParameters
→ String
no setter override
linkedName
→ String
late final inherited
linkedObjectType
→ String
no setter inherited
linkedParams
→ String
no setter inherited
linkedParamsLines
→ String
no setter inherited
linkedParamsNoMetadata
→ String ?
no setter inherited
linkedParamsNoMetadataOrNames
→ String
no setter inherited
location
→ String
A string indicating the URI of this Locatable, usually derived from
Element.location
.
no setter inherited
locationPieces
→ Set <String >
Pieces of the location, split to remove 'package:' and slashes.
late final inherited
modelBuilder
→ ModelObjectBuilder
Override implementations in unit tests to avoid requiring literal
ModelElement s.
late final inherited
modelElementRenderer
→ ModelElementRenderer
no setter inherited
modelNode
→ ModelNode ?
late final inherited
modelType
→ ElementType
no setter
name
→ String
no setter inherited
namePart
→ String
Utility getter/cache for _MarkdownCommentReference._getResultsForClass
.
late final inherited
namePieces
→ Set <String >
late final inherited
nameWithGenerics
→ String
no setter override
nameWithLinkedGenerics
→ String
no setter inherited
needsPrecache
→ bool
no setter inherited
oneLineDoc
→ String ?
no setter inherited
originalMember
→ Member?
no setter inherited
overriddenDepth
→ int ?
no setter inherited
package
→ Package
no setter override
packageGraph
→ PackageGraph
no setter inherited
parameters
→ List <Parameter >
late final inherited
pathContext
→ Context
no setter inherited
referenceChildren
→ Map <String , CommentReferable >
Map of referenceName to the elements that are a member of this , but
not this model element itself. Can be cached.
no setter
referenceGrandparentOverrides
→ Iterable <CommentReferable > ?
Replace the parents of parents. referenceBy ignores whatever might
otherwise be implied by the referenceParents of referenceParents ,
replacing them with this.
no setter inherited
referenceName
→ String
no setter inherited
referenceParents
→ Iterable <CommentReferable >
Iterable of immediate "parents" to try resolving component parts.
referenceBy stops at the first parent where a part is found.
Can be cached.
no setter
runtimeType
→ Type
A representation of the runtime type of the object.
no setter inherited
samples
→ String ?
Either a URI to documentation with samples,
or 'null' if one was not declared.
no setter inherited
scope
→ Scope?
For any CommentReferable
where an analyzer Scope
exists (or can
be constructed), implement this. This will take priority over
lookups via referenceChildren . Can be cached.
no setter inherited
sourceCode
→ String
late final inherited
sourceFileName
→ String
no setter inherited
sourceHref
→ String
late final inherited
subCategoryNames
→ List <String > ?
Either a set of strings containing all declared subcategories for this symbol,
or 'null' if none were declared.
no setter inherited
typeParameters
→ List <TypeParameter >
no setter override