@tutorial

Syntax

@tutorial tutorialID

Overview

@tutorial links a symbol to one of the tutorials you have configured in your JSDoc project. A "See Tutorials" section is added to the symbol's documentation page. Multiple @tutorial tags are allowed.

Example

/**
 * @tutorial getting-started
 * @tutorial authentication
 */
class ApiClient {}

See also

• {@tutorial}
• Tutorials overview
• Writing tutorials

Official reference: jsdoc.app/tags-tutorial