DocumentationComment mixin

Features for processing directives in a documentation comment.

processCommentWithoutTools and processComment are the primary entrypoints.

Superclass Constraints
Implemented by

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-only, 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 → List<ModelCommentReference>
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
modelNode ModelNode
read-only, inherited
characterLocation → CharacterLocation
read-only, inherited
hasSourceCode → bool
read-only, inherited
library Library
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
Returns 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

Operators

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