tags-todo.html

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

<head>
  <meta charset="utf-8">
  <meta name="description" content="Document tasks to be completed.">
  <title>Use JSDoc: @todo</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>@todo</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>
    </ul>
    <h2 id="syntax">Syntax</h2>
    <p><code>@todo text describing thing to do.</code>
    </p>
    <h2 id="overview">Overview</h2>
    <p>The @todo tag allows you to document tasks to be completed for some part of your code. You can use the @todo tag more than once in a single JSDoc comment.</p>
    <h2 id="examples">Examples</h2>
    <figure>
      <figcaption>Using the @todo tag</figcaption><pre class="prettyprint lang-js"><code>/**
 * @todo Write the documentation.
 * @todo Implement this function.
 */
function foo() {
    // write me
}
</code></pre>
    </figure>
  </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>