You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It turns out that we're doing it wrong. After some experiments with jsdoc 3.3 (alpha), I was able to find a markup that works (includes inherited members, etc.).
/** * This event is fired whenever the user invokes the button, usually through a click or tap within * the bounds of the button. If the Button currently has the focus, it might also be fired through keyboard * events such as the spacebar or the enter key. * * It can be observed by listening to the `action` event of a Control. * * @event module:C#action * @type {object} * @property {HTMLElement} source - The source of the event *//** * The base class for all buttons. * @module C */define(['B'],function(B){/** * Creates a new ButtonBase. Must only be invoked by subclasses. * * @constructor * @alias module:C * @extends module:B * @param {object} config The configuration. * @param {boolean} config.enabled `true`, if the button is enabled; `false`, otherwise. */varexports=functionButtonBase(config){installer(this);config=_.defaults(config||{},{tabIndex: 0});if(!config.skin)config.skin=newButtonBase.Skin(this,config.element);Labeled.call(this,config);this.classList.add('jide-buttonbase');}Class(ButtonBase).extends(Labeled).def({/** * `true`, if the button is enabled; `false`, otherwise. * * A disabled button does not react to user interaction. Set the value of this property to `false` if a * command is currently not available. * * @type boolean */enabled: true,/** * `true`, if the button is enabled; `false`, otherwise. * @type module:A */enabledProperty: null,command: null,commandProperty: null,dispose: function(){Labeled.prototype.dispose.call(this);installer.dispose(this);}});returnButtonBase;});
It is extremly important to include the var exports = part when defining the constructor. If that line is not present, inheritance documentation will not work.
The text was updated successfully, but these errors were encountered:
It turns out that we're doing it wrong. After some experiments with jsdoc 3.3 (alpha), I was able to find a markup that works (includes inherited members, etc.).
It is extremly important to include the
var exports =
part when defining the constructor. If that line is not present, inheritance documentation will not work.The text was updated successfully, but these errors were encountered: