js-skald/tests/prototypes.js

The simple JavaScript API reference/code documentation generator

/** My prototype class
 *
 * This is a simple prototype class.
 *
 * @author chris chris
 * @todo This is not doing anything at the moment
 * @deprecated
 * @constructor
 * 
 * @example My named example
 *
 * //Create a new instance of MyClass
 * var myClass = new MyClass({
 *     thing: function () {
 *         console.log('HelloWorld');
 *     }
 * });
 *
 * @example
 *
 * //Say hello
 * (new MyClass()).helloWorld();
 *
 * @emits MyEvent {object} - emitted at some point
 *   > a {string} - the a value
 *   > b {string} - the b value
 *
 * @param args {object} - the arguments
 */
myNamespace.MyClass = function (args) {
    
}

/** Say hello 
 * @param text {string} - the text to output
 */
myNamespace.MyClass.prototype.helloWorld = function (text) {
    console.log('Hello world!');
};

/** Some data 
 * @type {string}
 */
myNamespace.MyClass.prototype.Data = '123';

/** A simple function */
function foobar() {

}

/** A simple namespaced function */
myNamespace.test = function () {

}