Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 814 Bytes

File metadata and controls

42 lines (30 loc) · 814 Bytes
tag tutorial
tags blockTags
description Insert a link to an included tutorial file.
related
/about-tutorials
/tags-inline-tutorial
/tags-see

Syntax

@tutorial <tutorialID>

Overview

The @tutorial tag inserts a link to a tutorial file that is provided as part of the documentation. See the tutorials overview for instructions on creating tutorials.

You can use the @tutorial tag more than once in a single JSDoc comment.

Examples

In the following example, the documentation for MyClass will link to the tutorials that have the identifiers tutorial-1 and tutorial-2:

::: example "Using the @tutorial tag"

/**
 * Description
 * @class
 * @tutorial tutorial-1
 * @tutorial tutorial-2
 */
function MyClass() {}

:::