A model that represents a comment.
Instances of this model are created by the CommentPlugin. You can retrieve comments through the DeclarationReflection.comment property.
All associated block level tags.
All modifier tags present on the comment, e.g.
The content of the comment which is not associated with a block tag.
Label associated with this reflection, if any (https://tsdoc.org/pages/tags/label/)
Test whether this comment contains a tag with the given name.
The name of the tag to look for.
TRUE when this comment contains a tag with the given name, otherwise FALSE.
Has this comment a visible component?
TRUE when this comment has a visible component.
Returns true if this comment is completely empty.
Removes all block tags with the given tag name from the comment.
Debugging utility for combining parts into a simple string. Not suitable for rendering, but can be useful in tests.
Helper 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
Generated using TypeDoc