@document

Tag Kind

Block

TSDoc Reference

TypeDoc specific

Instructs TypeDoc to include the path specified in the tag content as a document within the generated site. See the External Documents guide for more details.

Example

/**
 * @document promise-tutorial.md
 */
export class Promise<T> {
    // ...
}

See Also

• The projectDocuments option