UNPKG

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

17 lines (16 loc) 630 B
module.exports = { 'augments': 'uses', // YUI convention for prototype mixins 'depreciated': 'deprecated', // subtle difference 'desciption': 'description', // shouldn't need the @description tag at all 'extend': 'extends', // typo 'function': 'method', // we may want standalone inner functions at some point 'member': 'method', // probably meant method 'parm': 'param', // typo 'params': 'param', // typo 'pamra': 'param', // typo 'parma': 'param', // typo 'propery': 'property', // typo 'prop': 'property', // probably meant property 'returns': 'return' // need to standardize on one or the other };