Creates a new Comment instance.
All associated block level tags.
All modifier tags present on the comment, e.g. @alpha
, @beta
.
The content of the comment which is not associated with a block tag.
Optional
labelLabel associated with this reflection, if any (https://tsdoc.org/pages/tags/label/)
Return the first tag with the given name.
The name of the tag to look for.
The found tag or undefined.
Get all tags with the given tag name.
Static
cloneStatic
combineDebugging utility for combining parts into a simple string. Not suitable for rendering, but can be useful in tests.
Static
deserializeStatic
displayHelper function to convert an array of comment display parts into markdown suitable for
passing into Marked. urlTo
will be used to resolve urls to any reflections linked to with
@link
tags.
Static
serializeGenerated using TypeDoc
A model that represents a comment.
Instances of this model are created by the CommentPlugin. You can retrieve comments through the comment property.