Finally, after Tine 2.0’s Milestone 2 is released, I found some time to upgrade the jsdoc-tk-ext package which now comes in version 0.4.
Thanks to contributions from the ExtJS-Forums documentation of Ext.ux classes is greatly improved. Moreover I spend some time to ease invocation of the toolkit.
The Tine 2.0 JS API Documentation got generated with a simple:
~/jsdoc$ java -jar jsrun.jar app/main.js -H='Tine 2.0 JS API Documentation' -r  ../tine20
Changes in Detail:
- make it running with windows (thanks Sierk)
- include return comments (thanks Sierk)
- allow to use shortcuts for @cfg in ExtJS doc style (thanks duralabh)
- allow to specify config options for undefined properties (thanks duralabh)
- allow to use new config format for properties and config (thanks duralabh)
- use exjs logo (requested by jack slocum)
- allow to document classes which are defined into global namespace (thanks SamuraiJack1)
- set ext template as defaultÂ
- include a copy of extjs
- remove dumper dependencies
- make headline configurable
- some code cleanup
Hi,
just been playing with your jsdoc toolkit, which mostly seems to work great. However, I’m not sure how to get the general notes at the top of a class in there. For example, I’m hoping to be able to write something like the following in my source code
/**
* @class MyComponent
* @extends Ext.Component
* I want to be able to describe some general stuff about my class here,
* going over multiple lines and using markup, just like Ext does
*/
MyComponent = Ext.extend(Ext.Component, {
…
and get that stuff between the tags to appear above the config options, methods, etc, in the docs page about this class. Looking in the Ext source, they do this. However, with the toolkit that comment seems to become part of the ‘extends’ string. Am I doing something wrong?
Since you put this out in August, have there been any developments?
never mind that last comment. I figured it out. You put it at the top, rather than below @extends
allow to specify config options for undefined properties ?
how do it?
I test always failure.
thanks
Cornelius,
Thanks for posting your 0.4 version. It works pretty well and I like the output format, and the fact that it is based on a jsdoc-toolkit template. But just wondering, are you planning on releasing any more versions or is this pretty much it? Thanks,
Rob