TypeDoc API - v0.28.2

    Interface CommentTag

    interface CommentTag {
        content: JSONOutput.CommentDisplayPart[];
        tag: `@${string}`;
        name?: string;
    }

    Hierarchy

    Index

    Properties

    content tag name?

    Properties

    content

    content: JSONOutput.CommentDisplayPart[]
    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.

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR