TypeDoc API - v0.28.14
    Preparing search index...

    Interface CommentTag

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

    Hierarchy

    Index

    Properties

    content tag name? typeAnnotation?

    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.

    typeAnnotation?: string

    Optional type annotation associated with this tag. TypeDoc will remove type annotations unless explicitly requested by the user with the preservedTypeAnnotationTags option.

    Settings

    Member Visibility

    On This Page

    Properties