Comments (2)
Thinking of taking the jsdoc-toolkit-style approach:
/**
* @cfg {Function} handler A callback that gets passed the following parameters:
* @cfg {Object} handler.userInfo A userinfo object:
* @cfg {String} handler.userInfo.name The name of the user.
* @cfg {String} handler.userInfo.email The email of the user.
*/
handler: Ext.emptyFn,
Same thing with method parameters:
/**
* @param {Function} handler A callback that gets passed the following parameters:
* @param {Object} handler.userInfo A userinfo object:
* @param {String} handler.userInfo.name The name of the user.
* @param {String} handler.userInfo.email The email of the user.
* @param {Object} scope Scope for the callback.
*/
doSomething: function(handler, scope) {
},
The main question is how to document the return value of the function. We could simply treat the name "return" specially:
/**
* @cfg {Function} handler A callback that gets passed the following parameters:
* @cfg {String} handler.return The formatted value
*/
handler: Ext.emptyFn,
This shouldn't cause any conflicts because "return" is a reserved keyword and you can't use it as function parameter name.
from jsduck.
Finally, this is now implemented.
from jsduck.
Related Issues (20)
- Does sencha docs use a private tool now? HOT 1
- Simple HTML example showing glyph with JavaScript constant HOT 1
- Opening JSDuck via index.php breaks JSONP loading
- What is "description" doing in guides?
- Documentation coverage HOT 8
- windows executable listed as malicious HOT 1
- How to hide the Array Boolean item HOT 2
- JSDuck & ExtJS6 - Universal app. HOT 3
- cannot load such file --rubygems.rb HOT 2
- Error thrown when running HOT 2
- jsduck 6.0.0.beta does not support encoding gb2312? HOT 1
- jsduck: command not found HOT 1
- why @example tag can't show 'Code Editor' & 'Live Preview' btn? HOT 3
- why ckfinder not working on hosting HOT 2
- Custom "inline" tags for Guides HOT 2
- Have a way to prevent loading external resources HOT 2
- Why on code don't useing parse self-contained function HOT 1
- Archive & Alternatives HOT 1
- XSS Injection in JSDuck
- Oops...
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from jsduck.