Class CommentTag

A model that represents a single TypeDoc comment tag.

Tags are stored in the Comment.blockTags property.

Constructors

Properties

Methods

Constructors

Properties

The actual body text of this tag.

tag: `@${string}`

The name of this tag, e.g. @returns, @example

name?: string

Some tags, (@typedef, @param, @property, etc.) may have a user defined identifier associated with them. If this tag is one of those, it will be parsed out and included here.

Methods

Generated using TypeDoc