Creates a new Comment instance.
The text of the @returns tag if present.
The abstract of the comment. TypeDoc interprets the first paragraph of a comment as the abstract.
All associated tags.
The full body text of the comment. Excludes the shortText.
Copy the data of the given comment into this comment.
shortText, text, returns and tags from COPIED_TAGS are copied;
other instance tags left unchanged.
Source comment to copy from
Return the first tag with the given name.
You can optionally pass a parameter name that should be searched to.
The name of the tag to look for.
An optional parameter name to look for.
The found tag or undefined.
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.
Removes all tags with the given tag name from the comment.
Generated using TypeDoc
A model that represents a comment.
Instances of this model are created by the CommentPlugin. You can retrieve comments through the DeclarationReflection.comment property.