Comments (6)
cc @wkeese
from js-doc-parse.
It seems that using only the "returns:" keyword gives an extra null or object return type:
<return-types>
<return-type type="Number" />
<return-type type="null" />
</return-types>
or
<return-types>
<return-type type="Number" />
<return-type type="object" />
</return-types>
from js-doc-parse.
In order to start the doc update of the source files, I would like to know what's planned to support return type documentation.
According to http://livedocs.dojotoolkit.org/util/doctools/markup,
- the returns keyword "does not include a type, which should appear within the function"
- "Because a function can return multiple types, the types should be declared on the same line as the return statement"
Do you plan to follow these guidelines ? In particular, that the "returns" key should not include the return type ?
from js-doc-parse.
we have tons of returns: Type, so I hope this will still be supported!
from js-doc-parse.
dojodoc.js::generateMetadata() has code for the doc-hints:
else if (value.raw.type === 'ReturnStatement') {
// Comment at the end of the first line of the return statement, if one exists
candidate = /^[^\n]*\/\/(.*?)\n/.exec(util.getSourceForRange(value.raw.range));
The problem is that generateMetadata() isn't called on return statement at all. Reproducible with a simple test case like:
define([], function(){
return function(){
return "foo"; // dojo/NodeList
};
});
Looks like a problem in esprimaParser.js: Nothing inside the function is getting processed. (I can add a for() loop outside the function and see ForStatement getting called, but if the for() loop is inside the function ForStatement isn't called.)
from js-doc-parse.
i think this original issue would be fixed by d86cc3a in #80
from js-doc-parse.
Related Issues (20)
- return query(...) // dojo/NodeList not working HOT 2
- property's summary gets assigned to the property's value HOT 4
- monkey-patched functions erase original function doc HOT 4
- fx.js makes other file lose easing and duration kwargs definition HOT 3
- kwargs definition using declare() to extend from plain function() broken HOT 1
- inline expansion of union types with kwargs doesn't work HOT 2
- comment on line declaring export variable masks summary HOT 3
- fragile regex for union types HOT 1
- inline return types often ignored HOT 1
- properties added from one module to another sometimes don't show up HOT 1
- dojodoc for properties with dashes ignored HOT 1
- js-doc-parser errors HOT 2
- Ubuntu/Canonical process.execPath = /usr/bin/nodejs HOT 1
- Add support for documenting attach points and attach events HOT 2
- tree.json no longer generated HOT 1
- ERR: TypeError: Object true has no method 'match' HOT 6
- parse.bat config = ./config.js produces error "ERR: TypeError: Object true has no method 'match'" HOT 1
- dynamic AMD require
- js-doc-parse traces when require()ing external url
- UMD modules HOT 1
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 js-doc-parse.