DocCommentinterfaceno test imports itinterface DocCommentThe parts of a TSDoc comment.
| Member | Type | What it is |
|---|---|---|
summary | string | What comes before the first block tag. |
remarks? | string | @remarks: the longer account. |
limits? | string | @limits: what it does not do, or does only in part. |
examples | readonly string[] | Each @example. |
see | readonly string[] | Each @see. |
params | readonly DocParam[] | Each @param. |
returns? | string | @returns. |
deprecated? | string | @deprecated, with why. |
isModule | boolean | Whether it says @module. |