jsduck icon indicating copy to clipboard operation
jsduck copied to clipboard

Documentation coverage

Open cope opened this issue 8 years ago • 8 comments

Any plans on adding documentation coverage reports, like this one from esdoc?

'Cause that would be awesome!

cope avatar Feb 28 '17 17:02 cope

The truth is that JSDuck is not really maintained any more. So less than unlikely to happen.

28.02.2017 19:39 kirjutas kuupäeval "Predrag Stojadinović" < [email protected]>:

Any plans on adding documentation coverage reports, like this one from esdoc https://doc.esdoc.org/github.com/esdoc/esdoc/source.html?

'Cause that would be awesome!

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/senchalabs/jsduck/issues/666, or mute the thread https://github.com/notifications/unsubscribe-auth/AAHNuThDGU2Dyz6KIsp_jeJz-doSbHoAks5rhFuygaJpZM4MOs88 .

nene avatar Feb 28 '17 18:02 nene

Is there a successor? Is there something different that Sencha is now recommending? I've been using this for 3 years and remain pretty happy with it, but always happy to look at other projects.

michaelkantor avatar Mar 10 '17 21:03 michaelkantor

What is Sencha using for documentation now?

cope avatar Mar 10 '17 23:03 cope

My guess is that they're still using JSDuck under the hood to extract docs from source code, but have built a new UI for showing the docs.

But these are just guesses. I'm not in contact with Sencha any more.

nene avatar Mar 11 '17 13:03 nene

It appears this forum thread is related to this question https://www.sencha.com/forum/showthread.php?311491

greg.barry: I'd love for the new docs software to be utilized by the community. That said, it's not currently set up to be shared outside of Sencha yet. We'll have to have some internal dialogue about the best way to potentially distribute this for other developers to use.

valioDOTch avatar Mar 13 '17 16:03 valioDOTch

PS: it appears there is some undocumented tool available via SenchaCmd called doxi https://www.sencha.com/forum/showthread.php?311491-Will-the-new-documentor-be-available-for-our-own-apps&p=1137925&viewfull=1#post1137925 figuring out the details now for the config file... project.doxi.json.zip

valioDOTch avatar Mar 13 '17 16:03 valioDOTch

Yeah; I saw that. However, it only outputs JSON, and leaves it to you to build the HTML. I rather like the JSDuck HTML; its part of why I use it (I'm not developing using a sencha JS framework). I don't currently have time budgeted to design and build an entire HTML generator that is as good. This project still works; hopefully they'll have open sourced everything before this starts to break down.

michaelkantor avatar Mar 13 '17 16:03 michaelkantor

The problem I have with JSDuck currently is that there's no new release which would fix some bugs like #491 :-(

valioDOTch avatar Mar 13 '17 16:03 valioDOTch