@privateRemarks

Tag Kind: Block
TSDoc Reference: @privateRemarks

The @privateRemarks tag can be used to include documentation text that should not be included in the generated API reference.

/**
* Some docs here
*
* @privateRemarks
* Implementation detail notes not useful to the API consumer
*/
export function rand(): number;

TypeDoc will omit this tag from the documentation by default, but the user is responsible for including it in the --excludeTags list if it is set.