Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CommentTag

A model that represents a single javadoc comment tag.

Tags are stored in the Comment.tags property.

Hierarchy

  • CommentTag

Index

Constructors

Properties

Methods

Constructors

constructor

  • new CommentTag(tagName: string, paramName?: string, text?: string): CommentTag

Properties

paramName

paramName: string

The name of the related parameter when this is a @param tag.

tagName

tagName: string

The name of this tag.

text

text: string

The actual body text of this tag.

Methods

toObject

  • toObject(): any
  • Return a raw object representation of this tag.

    deprecated

    Use serializers instead

    Returns any

Generated using TypeDoc