KDevelop/QMLJS: Difference between revisions
Created page with "= JavaScript = == Documentation == For better static analysis we should parse and extract information of JSDoc-formatted comments: http://en.wikipedia.org/wiki/JSDoc We shou..." |
|||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
= JavaScript = | = JavaScript = | ||
== Documentation == | == Documentation == | ||
Latest revision as of 10:22, 15 March 2016
JavaScript
Documentation
For better static analysis we should parse and extract information of JSDoc-formatted comments: http://en.wikipedia.org/wiki/JSDoc
We should eventually write a documentation plugin. Maybe we could generalize the php-docs plugin to be extensible for arbitrary URLs / languages. For JavaScript this seems to be a good page for English developers: https://developer.mozilla.org/en-US/docs/JavaScript/Reference While this is a good one for German developers: http://de.selfhtml.org/javascript/objekte/
Generally, we'll need something similar to PHP's phpfunctions.php file to specify the default JavaScript browser API. It should be extensible by arbitrary files that specify non-browser APIs, e.g. for Kate scripting. Comments could come from JSDoc.
QML
binary plugin support
We should look at how QtCreator/QML figures out what API a plugin provides. We'll also need to be able to setup custom QML import paths probably.
project-specific API
If one works on a project that creates its own QML plugin we should be able to figure that out somehow using the project builder and the C++ language plugin. Then we could deduce the API directly from the C++ DUChain information.
documentation
I hope that we could make use of the QtHelp plugin for default QML types and should add proper support for DoxyQML for additional static analysis opportunities for custom QML types. http://agateau.com/2013/01/14/introducing-doxyqml/