tags-package.html

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

<head>
  <meta charset="utf-8">
  <meta name="description" content="This symbol is meant to be package-private.">
  <title>Use JSDoc: @package</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>@package</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>
    <p>With the JSDoc tag dictionary (enabled by default):</p>
    <p><code>@package</code></p>
    <p>With the <a href="https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler#jsdoc-tags">Closure Compiler</a> tag
      dictionary:</p>
    <p><code>@package [{typeExpression}]</code></p>
    <h2 id="overview">Overview</h2>
    <p>The <code>@package</code> tag marks a symbol as package-private. Typically, this tag indicates that a symbol is
      available only to code in the same directory as the source file for this symbol. This tag is
      available in JSDoc 3.5.0 and later.</p>
    <p>By default, symbols marked with the <code>@package</code> tag will appear in your documentation. In JSDoc
      3.3.0 and later, you can use the <a href="about-commandline.html"><code>-a/--access</code> command-line option</a> to change this
      behavior.</p>
    <p>The <code>@package</code> tag is equivalent to <code>@access package</code>.</p>
    <h2 id="examples">Examples</h2>
    <p>In the following example, the instance member <code>Thingy#_bar</code> appears in the generated documentation,
      but with an annotation indicating that it is package-private:</p>
    <figure>
      <figcaption>Using the @package tag</figcaption>
      <pre class="prettyprint lang-js"><code>/** @constructor */
function Thingy() {
    /** @package */
    this._bar = 1;
}
</code></pre>
    </figure>
    <h2 id="related-links">Related Links</h2>
    <ul>
      <li>
        <a href="tags-access.html">@access</a>
      </li>
      <li>
        <a href="tags-global.html">@global</a>
      </li>
      <li>
        <a href="tags-instance.html">@instance</a>
      </li>
      <li>
        <a href="tags-private.html">@private</a>
      </li>
      <li>
        <a href="tags-protected.html">@protected</a>
      </li>
      <li>
        <a href="tags-public.html">@public</a>
      </li>
      <li>
        <a href="tags-static.html">@static</a>
      </li>
    </ul>
  </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>