Class CommentTag

A model that represents a single TypeDoc comment tag.

Tags are stored in the Comment.blockTags property.

Constructors

Properties

The actual body text of this tag.

skipRendering: boolean = false

A flag which may be set by plugins to prevent TypeDoc from rendering this tag, if the plugin provides custom rendering. Note: This flag is not serialized, it is expected to be set just before the comment is rendered.

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

  • Checks if this block tag is roughly equal to the other tag. This isn't exactly equal, but just "roughly equal" by the tag text.

    Parameters

    Returns boolean