A model that represents a comment.

Instances of this model are created by the CommentPlugin. You can retrieve comments through the comment property.

Hierarchy

  • Comment

Constructors

Properties

blockTags: CommentTag[] = []

All associated block level tags.

modifierTags: Set<string> = ...

All modifier tags present on the comment, e.g. @alpha, @beta.

The content of the comment which is not associated with a block tag.

Methods

  • Test whether this comment contains a tag with the given name.

    Returns

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

    Parameters

    • tagName: `@${string}`

      The name of the tag to look for.

    Returns boolean

  • Has this comment a visible component?

    Returns

    TRUE when this comment has a visible component.

    Returns boolean

  • Removes all block tags with the given tag name from the comment.

    Parameters

    • tagName: `@${string}`

    Returns void

  • Helper utility to clone summary or content

    Parameters

    Returns ({
        kind: "text";
        text: string;
    } | {
        kind: "code";
        text: string;
    } | {
        kind: "inline-tag";
        tag: `@${string}`;
        text: string;
        target?: string | Reflection;
    })[]

Generated using TypeDoc