short-jsdoc
Version:
short and simple jsdoc Object Oriented syntax format and implementation
71 lines (49 loc) • 1.26 kB
JavaScript
//@module life
//@class Living @extends Thing
//@method breath @param {Number} size
//@class Animal @extends Living
//@method eat @param {Array<Food>} food @return {Array<Energy>}
//@class Person A person is an animal that knows some specialized stuff like @?method crossStreet @extends Animal
//@method walk @return {Action}
/*@method crossStreet
This try to be a *markdown* [text](http://google.com)
Another paragraph
var someMarkup = {
a: 1
, n: 2
, g: function (e)
{
return 1;
}
};
and some final text with a list
1. First ordered list item
2. Another item
* Unordered sub-list.
1. Actual numbers don't matter, just that it's a number
1. Ordered sub-list
2. hello
4. And another item.
*/
//@method talk @public
// @property pprivate alkjsd lakjs dlka jsld k
// @property ppublic alksjd lka jsdl kalsjd kaj sd @public
/*
@event afterSleep this is triggered after the person ends sleeping. Example:
var b = 1
List:
* hello
* *world*
@public
@event beforeBath triggered just before the person is going to bath @public
@attribute {String} price lasdfj laksjd lfk jaslkd jflka sjlkdf jasd:
var i = 9
alksjdlaksjd:
1. alksjd
* alksjd
* alskdj
2. asldkfjsd
* jsjsjsjs sjsjs
* klsdjafh kasjdhkfjs
@public
*/