DocumentationComment mixin - dartdoc library

Constructors

DocumentationComment()

Properties

documentationComment → String: read-only
hasNodoc → bool: Returns true if the raw documentation comment has a nodoc indication.
read-only
sourceFileName → String: read-only
fullyQualifiedNameWithoutLibrary → String: read-only
pathContext → Context: read-only
modelElementRenderer → ModelElementRenderer: read-only
documentation → String: read-only, inherited
documentationAsHtml → String: read-only, inherited
hasDocumentation → bool: read-only, inherited
hasExtendedDocumentation → bool: read-only, inherited
oneLineDoc → String: read-only, inherited
packageGraph ↔ PackageGraph: read / write, inherited
isDocumented → bool: read-only, inherited
config → DartdocOptionContext: read-only, inherited
href → String: read-only, inherited
kind → String: read-only, inherited
name → String: read-only, inherited
fullyQualifiedName → String: read-only, inherited
namePieces → Set<String>: read-only, inherited
namePart → String: Utility getter/cache for _MarkdownCommentReference._getResultsForClass.
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
element → Element: read-only, inherited
enclosingElement → Warnable: read-only, inherited
package → Package: read-only, inherited
isCanonical → bool: read-only, inherited
canonicalLibrary → Library: 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
locationPieces → Set<String>: Pieces of the location, split to remove 'package:' and slashes.
read-only, inherited
documentationFrom → List<Locatable>: read-only, inherited
documentationIsLocal → bool: True if documentationFrom contains only one item, this.
read-only, inherited
location → String: A string indicating the URI of this Locatable, usually derived from Element.location.
read-only, 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.
read-only, 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. [...]
read-only, 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.
read-only, inherited
referenceGrandparentOverrides → Iterable<CommentReferable>: Replace the parents of parents. referenceBy ignores whatever might otherwise be implied by the referenceParents of referenceParents, replacing them with this.
read-only, inherited
referenceName → String: read-only, inherited
library → Library: read-only, inherited
modelNode → ModelNode: read-only, inherited
characterLocation → CharacterLocation: read-only, inherited
hasSourceCode → bool: read-only, inherited
sourceCode → String: read-only, inherited

Methods

computeDocumentationComment() → String: Implement to derive the raw documentation comment string from the analyzer.
processCommentWithoutTools(String documentationComment) → String: Process a documentationComment, performing various actions based on {@}-style directives, except {@tool}, returning the processed result.
processComment(String documentationComment) → Future<String>: Process documentationComment, performing various actions based on {@}-style directives, returning the processed result.
processCommentDirectives(String docs) → String
toString() → String: A string representation of this object. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a non-existent method or property is accessed. [...]
inherited
warn(PackageWarning kind, {String message, Iterable<Locatable> referredFrom, Iterable<String> extendedDebug}) → void: 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
referenceBy(List<String> reference, {bool tryParents = true, bool filter(CommentReferable), bool allowTree(CommentReferable), Iterable<CommentReferable> parentOverrides}) → 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. Will skip over entire subtrees whose parent node does not pass allowTree.
@nonVirtual, inherited
lookupViaScope(ReferenceChildrenLookup referenceLookup, bool allowTree(CommentReferable), bool filter(CommentReferable)) → CommentReferable: Looks up references by scope, skipping over results that do not match the given filter. [...]
inherited
recurseChildrenAndFilter(ReferenceChildrenLookup referenceLookup, CommentReferable result, {bool allowTree(CommentReferable), bool filter(CommentReferable)}) → CommentReferable: Given a result found in an implementation of lookupViaScope or _lookupViaReferenceChildren, recurse through children, skipping over results that do not match the filter.
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

Operators

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