@category

Tag Kind

Block

TSDoc Reference

TypeDoc specific

The @category tag can be used to place several related API items under a common header when listed in a page's index. It may be specified multiple times to list a reflection under several headings.

Example

/**
 * @category General Use
 */
export function runProcess(): void;

/**
 * @category Advanced Use
 */
export function unref(): void;

/**
 * @category Advanced Use
 */
export function ref(): void;

See Also

• The @group tag
• The --categorizeByGroup option
• The --defaultCategory option
• The --categoryOrder option
• The --searchCategoryBoosts option