ContainerMember mixin

A ModelElement that is a Container member.

Superclass constraints
Implemented types
Mixin applications

Properties

allParameters List<Parameter>
latefinalinherited
annotations Iterable<Annotation>
latefinalinherited
canonicalEnclosingContainer Container?
no setter
canonicalLibrary Library?
latefinalinherited
canonicalModelElement ModelElement?
latefinalinherited
characterLocation → CharacterLocation?
latefinalinherited
compilationUnitElement → CompilationUnitElement?
no setterinherited
config DartdocOptionContext
latefinalinherited
definingCommentReferable → CommentReferable
For testing / comparison only, get the comment referable from where this ElementType was defined. Override where an Element is available.
no setterinherited
definingEnclosingContainer Container
latefinal
definingLibrary Library
no setterinherited
displayedCategories Iterable<Category?>
no setterinherited
displayedLanguageFeatures Iterable<LanguageFeature>
A list of language features that both apply to this ModelElement and make sense to display in context.
no setterinherited
documentation String
Returns the docs, stripped of their leading comments syntax.
no setterinherited
documentationAsHtml String?
latefinalinherited
documentationComment String
The rawest form of the documentation comment, including comment delimiters like ///, //, /*, */.
no setterinherited
documentationFrom List<DocumentationComment>
The ModelElement from which we will get documentation.
no setterinherited
documentationIsLocal bool
True if documentationFrom contains only one item, this.
no setterinherited
documentationLocal String?
no setterinherited
element → Element?
no setterinherited
elementDocumentation Documentation
latefinalinherited
enclosingElement ModelElement?
no setterinherited
exportedInLibraries Set<Library>?
no setterinherited
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 setteroverride
featuresAsString String
no setterinherited
fileName String
no setterinherited
filePath String?
no setterinherited
fileType String
no setterinherited
fullyQualifiedName String
Returns the fully qualified name.
latefinalinherited
fullyQualifiedNameWithoutLibrary String
no setterinherited
hasAnnotations bool
no setterinherited
hasCategoryNames bool
no setterinherited
hasDocumentation bool
no setterinherited
hasDocumentationComment bool
True if this has a synthetic/inherited or local documentation comment. False otherwise.
no setterinherited
hasFeatures bool
no setterinherited
hasFeatureSet bool
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
hasNodoc bool
Returns true if the raw documentation comment has a 'nodoc' indication.
latefinalinherited
hasParameters bool
no setterinherited
hasSourceCode bool
no setterinherited
hasSourceHref bool
no setterinherited
href String?
If canonicalLibrary (or canonicalEnclosingElement, for Inheritable subclasses) is null, href should be null.
no setterinherited
htmlId String
no setterinherited
isAsynchronous bool
no setterinherited
isCallable bool
no setterinherited
isCanonical bool
no setterinherited
isConst bool
no setterinherited
isDeprecated bool
no setterinherited
isDocumented bool
no setterinherited
isEnumValue bool
Whether this element is an enum value.
no setterinherited
isExecutable bool
no setterinherited
isExtended bool
True if this ContainerMember is from an applicable Extension. False otherwise, including if this ContainerMember's enclosingElement is the extension it was declared in.
no setter
isFinal bool
no setterinherited
isLate bool
no setterinherited
isLocalElement bool
no setterinherited
isNullSafety bool
no setterinherited
isPropertyAccessor bool
no setterinherited
isPropertyInducer bool
no setterinherited
isPublic bool
latefinalinherited
isPublicAndPackageDocumented bool
no setterinherited
isStatic bool
no setterinherited
kind String
A human-friendly name for the kind of element this is.
no setterinherited
library Library?
no setterinherited
linkedName String
latefinalinherited
linkedObjectType String
no setterinherited
linkedParams String
no setterinherited
linkedParamsLines String
no setterinherited
linkedParamsNoMetadata String?
no setterinherited
linkedParamsNoMetadataOrNames String
no setterinherited
location String
A string indicating the URI of this Locatable, usually derived from Element.location.
no setterinherited
locationPieces Set<String>
Pieces of the location, split to remove 'package:' and slashes.
latefinalinherited
modelBuilder → ModelObjectBuilder
Override implementations in unit tests to avoid requiring literal ModelElements.
latefinalinherited
modelElementRenderer → ModelElementRenderer
no setterinherited
modelNode ModelNode?
latefinalinherited
name String
no setterinherited
namePart String
Utility getter/cache for _MarkdownCommentReference._getResultsForClass.
latefinalinherited
namePieces Set<String>
latefinalinherited
needsPrecache bool
no setterinherited
oneLineDoc String?
no setterinherited
originalMember → Member?
no setterinherited
overriddenDepth int?
no setterinherited
package Package?
no setterinherited
packageGraph PackageGraph
no setterinherited
parameters List<Parameter>
latefinalinherited
pathContext → Context
no setterinherited
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 setterinherited
referenceGrandparentOverrides Iterable<Library>
Replace the parents of parents. referenceBy ignores whatever might otherwise be implied by the referenceParents of referenceParents, replacing them with this.
no setter
referenceName String
no setterinherited
referenceParents Iterable<Container>
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 setterinherited
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 setterinherited
sourceCode String
latefinalinherited
sourceFileName String
no setterinherited
sourceHref String
latefinalinherited

Methods

buildDocumentationAddition(String docs) String
Override this to add more features to the documentation builder in a subclass.
inherited
childLookups(List<String> reference) Iterable<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
compareTo(dynamic other) int
Compares this object to another object.
inherited
computeCanonicalEnclosingContainer() Container?
injectMacros(String rawDocs) String
Replace {@macro ...} in API comments with the contents of the macro
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent 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
referenceBy(List<String> reference, {required bool filter(CommentReferable?), required bool allowTree(CommentReferable?), bool tryParents = true, Iterable<CommentReferable>? parentOverrides}) → CommentReferable?
Look up a comment reference by its component parts.
inherited
scoreCanonicalCandidates(Iterable<Library> libraries) List<ScoredCandidate>
inherited
toString() String
A string representation of this object.
inherited
warn(PackageWarning kind, {String? message, Iterable<Locatable> referredFrom = const [], Iterable<String> extendedDebug = const []}) → void
inherited

Operators

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