Type alias CommentDisplayPart

CommentDisplayPart: {
    kind: "text";
    text: string;
} | {
    kind: "code";
    text: string;
} | {
    kind: "inline-tag";
    tag: `@${string}`;
    text: string;
    target?: string | number;
}

If target is a number, it is a reflection ID. If a string, it is a URL. target will only be set for @link, @linkcode, and @linkplain tags.

Generated using TypeDoc