@category

Tag Kind: Block

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

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

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

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

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

Category Descriptions

The @categoryDescription block 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.

Navigation Customization

Categories can be added to the navigation tree with the navigation.includeCategories option. This can be selectively enabled or disabled by specifying the @showCategories and @hideCategories modifier tags within the comment on the parent reflection.

See Also

• The @group tag
• The --categorizeByGroup option
• The --defaultCategory option
• The --categoryOrder option
• The --searchCategoryBoosts option
• The --navigation.includeCategories option