Here is my first package of the jsdoc-toolkit-ext. I had some homework to do, to avoid licensing issues and to have a cleanly serrated output package.
To use all you have to do, is to define a path to your ExtJS library in the app.main.js.
// path to ExtJS, relative to jsdoc-toolkit-ext
var pathToExtJS = '../ExtJS';
To run jsdoc, just go ahead as usual, e.g.:
java -jar jsrun.jar app/main.js -t=templates/ext -r ../tine20/Tinebase/js/ux/
If not specified differently, find the output package in
out/jsdox.
You can place this directory wherever you want, as it has no dependencies any more.
There is still some work to do, to make jsdoc-toolkit-ext compatible with the ExtJS doctag slang. If you like to help, please drop me a note.
I just tried your release.
This is what I found out:
JSDOC.Lang.read_hex() was a missing function – I copied it from jsdoc-tk 2.0
The publish.js is faulty because it forgets to copy numerous files which are also not available in the template directory. I copied all files from the sample documentation directory, and then it worked.
It is currently not possible to launch jsdoc from outside the jsdoc directory because of path errors. – With jsdoc-tk 1.x this was possible.
The package had all .svn directories included. Hint: (In case you did not just forget) make an svn export before releasing something.
Other than that it works, but shows the known limitations in the output, but I think that is clear, and I will not report the various problems unless desired.
All in all, great work so far, keep it up!! Even with the current flaws it is way better as the default jsdoc templates!
Works really well – thanks.
Do you have any plans to work with version 2 of the jsdoc-toolkit – the current beta (which looks close to launch) allows plugins which may work well with your solution.
@Shyru
Which operating system do you use? I have it running under OS X and Solaris w.o problems and without the need of JSDOC.Lang.read_hex() and Dumper.js.
Dumper.js has a license not compatible to the jsrun.jar, so i removed it. But I guess that it’s used in some exception cases.
I always let the svn information in, to allow easy updates.
@dan
yes, the stuff is based on 2.0. I’ll need to take a look how the plugin-manager developed, hopefully I can skip the custiom stuff and only supply a plugin for the official code.
Hey Cornelius.
I’ve started writing a blog-entry about Jsdoc Toolkit on my blog here
HI, you are making a great tool.
I still have a problem with template/ext. When i launch the script on windows xp,
java -jar jsrun.jar app/main.js -a -t=templates/ext -r ../JSSSOURCES
Then i get this output:
Plugin Ext installed
num classes: 7
The files are created but they are like this one:
http://emp1.fr/JSSOURCES_api.js.html
My template seams to be good, so what’s wrong please?
Hi,
I’ve just checked out the most recent version (on 8th July) including the patches that were submitted on the ext forum – everything gets generated, but nothing gets displayed in the tree.
Looking at the code, it’s trying to load child node data from Docs.classData – in the docs.js file that was output, Docs has no properties, it’s declared like so:
Docs = {};
Any idea what’s gone wrong? The last version I tried worked really well.
Thanks,
Dan