@global

Syntax

@global

Overview

@global marks a symbol as globally scoped, so it appears in the global namespace in the documentation regardless of where it is defined in the source code. Useful when a symbol is assigned to window or global inside a function.

Example

(function () {
  /**
   * The application version string.
   * @global
   * @type {string}
   */
  window.APP_VERSION = '1.0.0';
})();

See also

• @namespace
• @module

Official reference: jsdoc.app/tags-global