CommentNode

Description

Methods

• hasTag

  code

  Whether the comment has the specified tag

  hasTag(name: string): boolean

  Parameters

  name

  string

  The name of the documentation tag to check

  Returns

  boolean:

  True if the block tag exist, otherwise false

• getTag

  code

  Returns the first tag with the given name.

  getTag(name: string): CommentPart | undefined

  Parameters

  name

  string

  The name of the tag.

  Returns

  CommentPart | undefined:

  The first tag with the given name or undefined if no such tag exists.

• getAllTags

  code

  getAllTags(name: string): CommentPart[]

  Parameters

  name

  string

  Returns

  CommentPart[]:

• isIgnored

  code

  Whether the documentation comment has tags that make the associated declaration ignored for documentation purposes.

  isIgnored(): boolean

  Returns

  boolean:

  True if the symbol should be ignored based on the JSDoc, otherwise false

• serialize

  code

  Serializes the reflected node

  serialize(): CommentPart[]

  Returns

  CommentPart[]:

  The reflected node as a serializable object