firedoc
Version:
API Doc generator rewritten from [YUIDoc](https://github.com/yui/yuidoc). We use this tool to document a large JavaScript game engine [Fireball](http://github.com/fireball-x/fireball) at [docs-zh.fireball-x.com/api](http://docs-zh.fireball-x.com/api/) and
76 lines (62 loc) • 1.11 kB
JavaScript
/**
* Class description
* @module undefinedmodule
* @class ClazzExample
*/
/**
* @property {String} name - The prop 1
*/
/**
* The name2
* @property name2
* @type Object
*/
/**
* method1 description
* @method method1
* @param {String} name
* @return {String|Number}
*/
/**
* method2 description
* @method method2
*/
/**
* The second class
* @class SecondClazz
* @extends ClazzExample
*/
/**
* method2 description 2
* @method method2_with_description
* @param {String} name - The name description
* @return {String} The return value
*/
/**
* extended from class1 and rewritten in this class
* @method method1
* @param {String} name
* @return {String|Boolean}
*/
/**
* attribute
* @attribute attr1
*/
/**
* close attrubute
* @attribute attr2
*/
/**
* event ex
* @event evt1
* @for ClazzExample
*/
/**
* The enum description [example](undefinedmodule.ClazzExample.method1)
* @enum EnumEx
* @extend UnknownEnum
*/
/**
* @class ThirdClazz
* @extends ClazzExample
*/