How is JSDoc multiple inheritance or mixins?

Question

How to document mixins or multiple inheritance?

/**
 * @class Parent
 */
function Parent() {
}

Parent.prototype.parentTest = 5;

/**
 * @class Mixin
 */
function Mixin() {
}

Mixin.prototype.mixinTest = 5;

/**
 * @class Child
 * @augments Parent
 * @mixin Mixin
 */
function Child() {
}

Is there anything official from JsDoc? If not, how would you prefer it to be written?

Answer 1

Several are @augmentsactually supported by the JsDoc Toolkit (I have not tried it, but their unit tests offer so much, multiple ").

For Mixins, you can use @lendsand @borrows, see examples here: http://code.google.com/p/jsdoc-toolkit/wiki/CookBook

Answer 2

What about:

@mixin [<MixinName>]

Add to any objects that mix with:

@mixes <OtherObjectPath>

:

/**
 * This provides methods used for event handling. It not meant to
 * be used directly.
 *
 * @mixin
 */
var Eventful = {
    /**
     * Register a handler function to be called whenever this event is fired.
     * @param {string} eventName - Name of the event.
     * @param {function(Object)} handler - The handler to call.
     */
    on: function(eventName, handler) {
        // code...
    },

    /**
     * Fire an event, causing all handlers for that event name to run.
     * @param {string} eventName - Name of the event.
     * @param {Object} eventData - The data provided to each handler.
     */
    fire: function(eventName, eventData) {
        // code...
    }
};


/**
 * @constructor FormButton
 * @mixes Eventful
 */
var FormButton = function() {
    // code...
};
FormButton.prototype.press = function() {
  this.fire('press', {});
}
mix(Eventful).into(FormButton.prototype);

Hide result