tags-inline-tutorial.html

<!DOCTYPE html>
<!-- THIS IS A GENERATED FILE. DO NOT EDIT. -->
<html lang="en">

<head>
  <meta charset="utf-8">
  <meta name="description" content="Link to a tutorial.">
  <title>Use JSDoc: {@tutorial}</title>
  <link rel="stylesheet" href="styles/usejsdoc.css">
  <link rel="stylesheet" href="styles/prettify.css">
  <link rel="stylesheet" href="styles/css3-github-ribbon.css">
  <script src="scripts/prettify.js"></script>
</head>

<body>
  <header>
    <a href="./index.html">@use JSDoc</a>
  </header>
  <article>
    <h1>{@tutorial}</h1>
    <h2>Table of Contents</h2>
    <ul>
      <li>
        <a href="#syntax">Syntax</a>
      </li>
      <li>
        <a href="#overview">Overview</a>
      </li>
      <li>
        <a href="#examples">Examples</a>
      </li>
      <li>
        <a href="#related-links">Related Links</a>
      </li>
    </ul>
    <h2 id="syntax">Syntax</h2>
    <pre class="prettyprint"><code>{@tutorial tutorialID}
[link text]{@tutorial tutorialID}
{@tutorial tutorialID|link text}
{@tutorial tutorialID link text (after the first space)}
</code></pre>
    <h2 id="overview">Overview</h2>
    <p>The <code>{@tutorial}</code> inline tag creates a link to the tutorial identifier that you specify. When you
      use the <code>{@tutorial}</code> tag, you can also provide link text, using one of several different formats.
      If you don&#39;t provide any link text, JSDoc uses the tutorial&#39;s title as the link text.</p>
    <p>If you need to link to a namepath or a URL, use the <a href="tags-inline-link.html"><code>{@link}</code> inline tag</a> instead
      of the <code>{@tutorial}</code> tag.</p>
    <h2 id="examples">Examples</h2>
    <p>The following example shows all of the ways to provide link text for the <code>{@tutorial}</code> tag:</p>
    <figure>
      <figcaption>Providing link text</figcaption>
      <pre class="prettyprint lang-js"><code>/**
 * See {@tutorial gettingstarted} and [Configuring the Dashboard]{@tutorial dashboard}.
 * For more information, see {@tutorial create|Creating a Widget} and
 * {@tutorial destroy Destroying a Widget}.
 */
function myFunction() {}
</code></pre>
    </figure>
    <p>If all of these tutorials are defined, and the title of the <code>gettingstarted</code> tutorial is &quot;Getting
      Started,&quot; the example above produces output similar to the following:</p>
    <figure>
      <figcaption>Output for {@link} tags</figcaption>
      <pre class="prettyprint lang-html"><code>See &lt;a href="tutorial-gettingstarted.html">Getting Started&lt;/a> and
&lt;a href="tutorial-dashboard.html">Configuring the Dashboard&lt;/a>.
For more information, see &lt;a href="tutorial-create.html">Creating a Widget&lt;/a> and
&lt;a href="tutorial-destroy.html">Destroying a Widget&lt;/a>.
</code></pre>
    </figure>
    <h2 id="related-links">Related Links</h2>
    <p>
      <a href="tags-tutorial.html">@tutorial</a>
    </p>
  </article>
  <footer>
    <a class="license-badge" href="http://creativecommons.org/licenses/by-sa/3.0/">
      <img alt="Creative Commons License" class="license-badge" src="images/cc-by-sa.svg" width="80" height="15" /></a>
    <br>
    Copyright &#169; 2011-2017 the
    <a href="https://github.com/jsdoc3/jsdoc3.github.com/contributors">contributors</a> to the
    JSDoc 3 documentation project.
    <br>
    This website is <a href="https://github.com/jsdoc3/jsdoc3.github.com">open source</a> and is
    licensed under the <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">
      Creative Commons Attribution-ShareAlike 3.0 Unported License</a>.
  </footer>
  <script type="text/javascript">
    prettyPrint();
  </script>
</body>

</html>