@hideconstructor

Syntax

@hideconstructor

Overview

@hideconstructor hides the constructor signature from the generated documentation. Use it for classes whose constructors are internal implementation details and should not be called directly by users.

Example

/**
 * Singleton registry for plugins.
 * @hideconstructor
 */
class PluginRegistry {
  constructor() {
    if (PluginRegistry._instance) {
      return PluginRegistry._instance;
    }
    PluginRegistry._instance = this;
  }

  /** @param {Object} plugin */
  register(plugin) {}
}

See also

• @class
• @private

Official reference: jsdoc.app/tags-hideconstructor