Interface Comment

interface Comment {
    summary: JSONOutput.CommentDisplayPart[];
    blockTags?: JSONOutput.CommentTag[];
    label?: string;
    modifierTags?: `@${string}`[];
}

Hierarchy

Partial<S<Models.Comment, "blockTags" | "label">>
- Comment

Index

Properties

summary blockTags? label? modifierTags?

Properties

summary

summary: JSONOutput.CommentDisplayPart[]

`Optional` blockTags

blockTags?: JSONOutput.CommentTag[] = []

All associated block level tags.

`Optional` label

label?: string

Label associated with this reflection, if any (https://tsdoc.org/pages/tags/label/)

`Optional` modifierTags

modifierTags?: `@${string}`[]