GetterSetterCombo mixin

Mixin for top-level variables and fields (aka properties)

Superclass Constraints
Implemented by

Constructors

GetterSetterCombo()

Properties

enclosingElement ModelElement
read / write
getter Accessor
read-only
setter Accessor
read-only
annotations Iterable<Annotation>
read-only, override
allAccessors Iterable<Accessor>
read-only
comboFeatures Set<Feature>
@protected, read-only
isInherited bool
read-only
constantInitializer Expression
read-only
characterLocation CharacterLocation
read-only, override
constantValue String
read-only
constantValueTruncated String
read-only
constantValueBase String
read-only
hasPublicGetter bool
read-only
hasPublicSetter bool
read-only
isPublic bool
read-only, override
documentationFrom List<ModelElement>
read-only, override
hasAccessorsWithDocs bool
read-only
getterSetterBothAvailable bool
read-only
oneLineDoc String
read-only, override
getterSetterDocumentationComment String
read-only
modelType ElementType
read-only
isCallable bool
read-only, override
parameters List<Parameter>
read-only, override
linkedParamsNoMetadata String
read-only, override
hasExplicitGetter bool
read-only
hasExplicitSetter bool
read-only
hasGetter bool
read-only
hasNoGetterSetter bool
read-only
hasGetterOrSetter bool
read-only
hasSetter bool
read-only
hasPublicGetterNoSetter bool
read-only
arrow String
read-only
readOnly bool
read-only
readWrite bool
read-only
writeOnly bool
read-only
referenceChildren Map<String, CommentReferable>
Map of name to the elements that are a member of this, but not this model element itself. Can be cached.
read-only
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.
read-only
hasCategoryNames bool
read-only, inherited
displayedCategories Iterable<Category>
read-only, inherited
exportedInLibraries Set<Library>
read-only, inherited
modelNode ModelNode
read-only, inherited
commentRefs Map<String, ModelCommentReference>
A map of ModelCommentReference.codeRef to ModelCommentReference. This map deduplicates comment references as all identical reference strings inside a single documentation comment will point to the same place, so it should not be used to count exactly how many references there are.
read-only, inherited
config DartdocOptionContext
read-only, inherited
locationPieces Set<String>
Pieces of the location, split to remove 'package:' and slashes.
read-only, inherited
hasFeatures bool
read-only, 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.
read-only, inherited
featuresAsString String
read-only, inherited
canonicalModelElement ModelElement
read-only, inherited
hasSourceHref bool
read-only, inherited
sourceHref String
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
documentationLocal String
read-only, inherited
documentation String
Returns the docs, stripped of their leading comments syntax.
read-only, inherited
definingLibrary Library
read-only, inherited
canonicalLibrary Library
read-only, inherited
isCanonical bool
read-only, inherited
documentationAsHtml String
read-only, inherited
element Element
read-only, inherited
location String
A string indicating the URI of this Locatable, usually derived from Element.location.
read-only, inherited
Returns a link to extended documentation, or the empty string if that does not exist.
read-only, inherited
fileName String
read-only, inherited
fileType String
read-only, inherited
filePath String
read-only, inherited
fullyQualifiedName String
Returns the fully qualified name. [...]
read-only, inherited
fullyQualifiedNameWithoutLibrary String
read-only, inherited
sourceFileName String
read-only, inherited
compilationUnitElement CompilationUnitElement
read-only, inherited
hasAnnotations bool
read-only, inherited
hasDocumentation bool
read-only, inherited
hasExtendedDocumentation bool
read-only, inherited
hasParameters bool
read-only, inherited
href String
If canonicalLibrary (or canonicalEnclosingElement, for Inheritable subclasses) is null, href should be null.
read-only, inherited
htmlId String
read-only, inherited
isAsynchronous bool
read-only, inherited
isConst bool
read-only, inherited
isDeprecated bool
read-only, inherited
isDocumented bool
read-only, inherited
isExecutable bool
read-only, inherited
isFinal bool
read-only, inherited
isLate bool
read-only, inherited
isLocalElement bool
read-only, inherited
isPropertyAccessor bool
read-only, inherited
isPropertyInducer bool
read-only, inherited
isStatic bool
read-only, inherited
kind String
A human-friendly name for the kind of element this is.
read-only, inherited
library Library
read-only, inherited
linkedName String
read-only, inherited
modelElementRenderer → ModelElementRenderer
@visibleForTesting, read-only, inherited
linkedParams String
read-only, inherited
linkedParamsLines String
read-only, inherited
linkedParamsNoMetadataOrNames String
read-only, inherited
name String
read-only, inherited
originalMember → Member
read-only, inherited
packageGraph PackageGraph
read-only, inherited
package Package
read-only, inherited
isPublicAndPackageDocumented bool
read-only, inherited
allParameters List<Parameter>
read-only, inherited
pathContext Context
read-only, inherited
sourceCode String
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
documentationIsLocal bool
True if documentationFrom contains only one item, this.
read-only, inherited
namePieces Set<String>
read-only, inherited
namePart String
Utility getter/cache for _MarkdownCommentReference._getResultsForClass.
read-only, inherited
hasSourceCode bool
read-only, inherited
overriddenDepth int
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
hasFeatureSet bool
read-only, inherited
isNullSafety bool
read-only, inherited
documentationComment String
read-only, inherited
hasNodoc bool
Returns true if the raw documentation comment has a nodoc indication.
read-only, inherited

Methods

linkifyConstantValue(String original) String
buildCanonicalModelElement() ModelElement
inherited
buildDocumentationAddition(String docs) String
Override this to add more features to the documentation builder in a subclass.
inherited
computeDocumentationComment() String
Implement to derive the raw documentation comment string from the analyzer.
inherited
precacheLocalDocs() Future<void>
Unconditionally precache local documentation. [...]
inherited
compareTo(dynamic other) int
Compares this object to another object. [...]
inherited
toString() String
A string representation of this object. [...]
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
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
referenceBy(List<String> reference, {bool tryParents = true, bool filter(CommentReferable)}) → CommentReferable
Look up a comment reference by its component parts. If tryParents is true, try looking up the same reference in any parents of this. Will skip over results that do not pass a given filter and keep searching.
@nonVirtual, inherited
childLookups(List<String> reference) List<ReferenceChildrenLookup>
A list of lookups that should be attempted on children based on reference. This allows us to deal with libraries that may have separators in them. referenceBy stops at the first one found.
inherited
warn(PackageWarning kind, {String message, Iterable<Locatable> referredFrom, Iterable<String> extendedDebug}) → void
inherited
processCommentWithoutTools(String documentationComment) String
Process a documentationComment, performing various actions based on {@}-style directives, except {@tool}, returning the processed result.
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

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited