{@tutorial}

Syntax

{@tutorial tutorialID}
{@tutorial tutorialID|link text}
{@tutorial tutorialID link text}

Overview

{@tutorial} creates an inline hyperlink to one of the tutorials you have configured for your project (see Tutorials). It works like {@link} but targets a tutorial by its ID rather than a code symbol.

Example

/**
 * For a complete walk-through, see the {@tutorial getting-started} tutorial.
 */
class ApiClient {}

/**
 * Refer to {@tutorial authentication|the authentication guide} for setup instructions.
 */
function login(credentials) {}

See also

• {@link}
• @tutorial
• Writing tutorials

Official reference: jsdoc.app/tags-inline-tutorial