@inner

Syntax

@inner

Overview

@inner marks a symbol as an inner member — a symbol defined inside a function and only accessible from within that function. Inner members use ~ in their namepath: Parent~innerMember.

Example

/** @namespace */
var MyModule = (function () {
  /**
   * An inner helper — not exported.
   * @inner
   */
  function helper() {}

  return {
    run() { helper(); },
  };
})();

The namepath for helper is MyModule~helper.

See also

• @instance
• @static
• Namepaths guide

Official reference: jsdoc.app/tags-inner