interface_all.js

/** @module interfaces */

/**
 * Interface for classes that represent a color.
 *
 * @interface
 */
function Color() {}

/**
 * @function module:interfaces~Color.staticMethod1
 */
Color.staticMethod1 = function() {};

/**
 * @function
 * @static
 */
Color.staticMethod2 = function() {};

/**
 * @member {Number} module:interfaces~Color.staticMember1
 */
Color.staticMember1 = 1;

/**
 * @member {Boolean}
 * @static
 */
Color.staticMember2 = true;

/**
* @type {String}
* @name module:interfaces~Color.staticMember3
*/
Color.staticMember3 = "foobar";

/**
* @type {Object}
* @static
*/
Color.staticMember4 = {};

/**
 * @function
 */
Color.prototype.instanceMethod = function() {};

/**
 * @member {Number}
 */
Color.prototype.instanceMember = 5;

/**
 * Get the color as an array of red, green, and blue values, represented as
 * decimal numbers between 0 and 1.
 *
 * @returns {Array<number>} An array containing the red, green, and blue values,
 * in that order.
 */
Color.prototype.rgb = function() {
    throw new Error('not implemented');
};

/**
 * @function
 * @name [foobar1]
 * @memberof module:interfaces~Color#
 */
Color.prototype.foobar1 = function() {
    throw new Error('not implemented');
};

/**
 * @function [foobar2]
 * @memberof module:interfaces~Color#
 */
Color.prototype.foobar2 = function() {
    throw new Error('not implemented');
};

/**
 * @type {Boolean}
 * @name [foobar3]
 * @memberof module:interfaces~Color#
 */
Color.prototype.foobar3 = undefined;

/**
 * @member {String}
 * @name [foobar4]
 * @memberof module:interfaces~Color#
 */
Color.prototype.foobar4 = undefined;

/**
 * @member {Object} [foobar5]
 * @memberof module:interfaces~Color#
 */
Color.prototype.foobar5 = undefined;

module.exports = {
    Color: Color
}