Interface Comment

Hierarchy

Partial<S<M.Comment, "shortText" | "text" | "returns" | "tags">>
- Comment

Index

Properties

Properties

Optional returns

returns: string

The text of the @returns tag if present.

Optional shortText

shortText: string

The abstract of the comment. TypeDoc interprets the first paragraph of a comment as the abstract.

Optional tags

tags: CommentTag[]

All associated tags.

Optional text

text: string

The full body text of the comment. Excludes the shortText.

Generated using TypeDoc