Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Comment

A model that represents a javadoc comment.

Instances of this model are created by the [[CommentHandler]]. You can retrieve comments through the [[BaseReflection.comment]] property.

Hierarchy

  • Comment

Index

Constructors

constructor

  • new Comment(shortText?: string, text?: string): Comment

Properties

returns

returns: string

The text of the @returns tag if present.

shortText

shortText: string

The abstract of the comment. TypeDoc interprets the first paragraph of a comment as the abstract.

tags

tags: CommentTag[]

All associated javadoc tags.

text

text: string

The full body text of the comment. Excludes the shortText.

Methods

copyFrom

getTag

  • getTag(tagName: string, paramName?: string): CommentTag
  • Return the first tag with the given name.

    You can optionally pass a parameter name that should be searched to.

    Parameters

    • tagName: string

      The name of the tag to look for.

    • Optional paramName: string

      An optional parameter name to look for.

    Returns CommentTag

    The found tag or NULL.

hasTag

  • hasTag(tagName: string): boolean
  • Test whether this comment contains a tag with the given name.

    Parameters

    • tagName: string

      The name of the tag to look for.

    Returns boolean

    TRUE when this comment contains a tag with the given name, otherwise FALSE.

hasVisibleComponent

  • hasVisibleComponent(): boolean

toObject

  • toObject(): any

Generated using TypeDoc