Interface CommentNode

Comment/docstring structure from TypeDoc

interface CommentNode {
    blockTags?: {
        content: {
            kind: string;
            text: string;
        }[];
        tag: string;
    }[];
    summary?: {
        kind: string;
        text: string;
    }[];
}

Properties

blockTags? summary?

Properties

OptionalblockTags

blockTags?: {
    content: {
        kind: string;
        text: string;
    }[];
    tag: string;
}[]

Optionalsummary

summary?: {
    kind: string;
    text: string;
}[]

Settings

Member Visibility

On This Page

Properties