tags-license.html

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

<head>
  <meta charset="utf-8">
  <meta name="description" content="Identify the license that applies to this code.">
  <title>Use JSDoc: @license</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>@license</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>@license &lt;identifier&gt;</code>
    </p>
    <h2 id="overview">Overview</h2>
    <p>The <code>@license</code> tag identifies the software license that applies to any portion of your code.</p>
    <p>You can use any text to identify the license you are using. If your code uses a standard open-source license, consider using the appropriate identifier from
      the <a href="https://spdx.org/licenses/">Software Package Data Exchange (SPDX)
License List</a>.</p>
    <p>Some JavaScript processing tools, such as Google&#39;s Closure Compiler, will automatically preserve any JSDoc comment that includes a <code>@license</code>      tag. If you are using one of these tools, you may wish to add a standalone JSDoc comment that includes the <code>@license</code> tag, along with the entire
      text of the license, so that the license text will be included in generated JavaScript files.</p>
    <h2 id="examples">Examples</h2>
    <figure>
      <figcaption>A module that is distributed under the Apache License 2.0</figcaption><pre class="prettyprint lang-js"><code>/**
 * Utility functions for the foo package.
 * @module foo/util
 * @license Apache-2.0
 */
</code></pre>
    </figure>
    <figure>
      <figcaption>A standalone JSDoc comment with the complete MIT license</figcaption><pre class="prettyprint lang-js"><code>/**
 * @license
 * Copyright (c) 2015 Example Corporation Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
</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>