short-jsdoc/test/test-project/ideal/Model.js

short and simple jsdoc Object Oriented syntax format and implementation

//@module ideal
//@class BaseObject 
var s = 'these are just js sample sentences'; 
if(typeof sentence === 'undefined')
{
	console.log('alert'); 
}
//@property {Date} creationDate
//@property {String} name
//@property {String} description
//@property {Object<String,User>} owners the owners, a map by owner id
// @property {color:Color,amount:Number} something
function BaseObject(){};
// @method m @returns {Thing}

//@class ObjectPool
function ObjectPool(){};
//@method loadObjects @param {Array<String>} objects_ids @return {Object<String,BaseObject>}
ObjectPool.prototype.getOwners = function(objects_ids){return null;}

// @param {Array<String>} objects_ids
var s = 'these are just js sample sentences'; 
if(typeof sentence === 'undefined')
{
	console.log('alert'); 
}
// @method getState0 @returns {a:B231,c:D231,s:String}
// @method getState2 @returns {a:B231,c:D231}
// @method getState3 @re turns {#obj(color:String)}
// @method getState4 @returns {name:String,colors:Array<Color>,car:Car}
// @method getState get's the current state of this pool
// @returns {id:String,objectDic:Object<String>} bla bla bla
var getState=function(){};

//@method getOwners this method is useful for *blabla* blabla _blabla_ bab
var s = 'these are just js sample sentences'; 
if(typeof sentence === 'undefined')
{
	console.log('alert'); 
}



// @event objectCreated event fired when an object is created in this pool.
var s = 'these are just js sample sentences'; 
if(typeof sentence === 'undefined')
{
	console.log('alert'); 
}


//@class Thing @extends BaseObject
//@property {Number} importance the importance of this thing in the universe
// @property {ObjectPool} pool things always contain or are related to other things so this is the pool where this associations are mantained laskd flaks djflkasj dlkfj alsdkj flaksjd flkasjdlfkjs lkdfjalksdjflak sdjlfkasdf d s asdf  df ldkja sldkfj askd fasd. 

var s = 'these are just js sample sentences'; 
if(typeof sentence === 'undefined')
{
	console.log('alert'); 
}


/** @class Action @extends BaseObject */

var s = 'these are just js sample sentences'; 
if(typeof sentence === 'undefined')
{
	console.log('alert'); 
}

//@method extract @param {String|BaseObject|Array<BaseObject>} what