tags-see.html

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

<head>
  <meta charset="utf-8">
  <meta name="description" content="Refer to some other documentation for more information.">
  <title>Use JSDoc: @see</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>
  <!--[if lt IE 9]>
            <script src="scripts/html5shiv.min.js"></script>
            <script src="scripts/html5shiv-printshiv.min.js"></script>
        <![endif]-->
</head>

<body>
  <header>
    <a href="./index.html">@use JSDoc</a>
  </header>
  <article>
    <h1>@see</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>
    <ul>
      <li><code>@see &lt;namepath&gt;</code>
      </li>
      <li><code>@see &lt;text&gt;</code>
      </li>
    </ul>
    <h2 id="overview">Overview</h2>
    <p>The @see tag allows you to refer to another symbol or resource that may be related to the one being documented. You can provide either a symbol&#39;s namepath
      or free-form text. If you provide a namepath, JSDoc&#39;s default template automatically converts the namepath to a link.</p>
    <h2 id="examples">Examples</h2>
    <figure>
      <figcaption>Using the @see tag</figcaption><pre class="prettyprint lang-js"><code>/**
 * Both of these will link to the bar function.
 * @see {@link bar}
 * @see bar
 */
function foo() {}

// Use the inline {@link} tag to include a link within a free-form description.
/**
 * @see {@link foo} for further information.
 * @see {@link http://github.com|GitHub}
 */
function bar() {}
</code></pre>
    </figure>
    <h2 id="related-links">Related Links</h2>
    <p>
      <a href="tags-inline-link.html">{@link}</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-2014 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>