PDA

View Full Version : Are the docs still generated via JSDuck



anselmtmcclain
12 May 2017, 11:37 AM
Hi -

We were thinking about standardizing how we document some of our internal Ext components and I had planned to use JSDuck - https://github.com/senchalabs/jsduck

I noticed that the online API docs (docs.sencha.com) have just changed - but looking at JSDuck it does not appear as though the project has been updated in a long while.

Is JSDuck (or at least the version in the github repo) still the tool you are using to generate docs for the SDK? Would you still recommend its use?

Thanks - ATM

greg.barry
15 May 2017, 8:56 AM
anselmtmcclain (https://www.sencha.com/forum/member.php?32270-anselmtmcclain),

No, we no longer use JSDuck

We are currently using a new node-based solution that we have developed internally. JSDuck is still a fine solution though. We would like to share our solution for the public, but I don't know what the timeline is on that. We still have some work ahead before we'll feel comfortable sharing it with the community. We really want it to be successful.

You can read more about the initial release here:
https://www.sencha.com/blog/new-sencha-docs-are-coming-soon/

Thanks!
Greg

anselmtmcclain
15 May 2017, 9:18 AM
Appreciate the update, Greg. If there is any way for us to participate in a beta or similar, please let me know. I'll keep an eye out for any further updates.

Glad the "docs aren't an ext app" question was addressed by the blog - that's something our team had really wondered about!

greg.barry
15 May 2017, 9:23 AM
Great, thank you for the offer! We may very well take you up on the beta testing. I'll reach out as soon as we've finalized our plan internally (and when we get through the next week of releases).

Thanks!
Greg

bogc
31 May 2017, 9:22 PM
JSDuck is still a fine solution though

Just curious, does JSDuck still work with 6.5, or are there any incompatible tags?

Also, using the new documentation tool, is there a way to produce a file - json or xml - that contains the type information for methods, methods parameters and config parameters etc?

Thanks

valio
14 Jun 2017, 5:05 AM
Just curious, does JSDuck still work with 6.5, or are there any incompatible tags?
Depends what you need.

Stuff that doesn't work
* certain ES6 feature like template strings
* generating docs for multiple toolkits


Also, using the new documentation tool, is there a way to produce a file - json or xml - that contains the type information for methods, methods parameters and config parameters etc?

You might be looking for Doxi in SenchaCmd
(https://www.sencha.com/forum/showthread.php?311491-Will-the-new-documentor-be-available-for-our-own-apps&p=1137925&viewfull=1#post1137925)