@categoryDescription

Tag Kind

Block

TSDoc Reference

TypeDoc specific

The @categoryDescription tag can be used to provide additional context about a category of reflections which was created with the @category tag.

The @categoryDescription tag should be placed in the comment for the reflection which contains the child reflections marked with @category.

The first line of the @categoryDescription will be taken as the category name, and following lines will be used for the description.

Example

/**
 * @categoryDescription Advanced Use
 * These functions are available for...
 * @module
 */

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

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

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

See Also

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