Interface Comment

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

Hierarchy (View Summary)

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

Index

Properties

blockTags? label? modifierTags? summary

Properties

`Optional`blockTags

blockTags?: 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}`[]

summary

summary: CommentDisplayPart[]