27 Dec 2010 12:53 PM #1
JsDuck - an alternative documentation generator for ExtJS
Being dissatisfied with ext-doc I wrote an alternative documentation generator for ExtJS.
* JsDuck at Github
The highlights of JsDuck are:
* Comments can be formatted with Markdown instead of HTML.
* A lot more information is inferred from code - so you can keep your comments DRY.
While doing this, JsDuck aims to be backwards-compatible with ext-doc. So comments written for ext-doc will display about the same under JsDuck, but not the other way around.
It's still in early beta, so there's a lot of stuff in my TODO list, but I've already found it quite satisfying to use - not having to type @class and @extends at all have greatly increased my refactoring speed, and the reduced boilerplate code has made me less reluctant to create small little classes.
Tell me what you think.
PS. While developing it I discovered several bugs in ExtJS doc-comments. I've created a list of them for those who care to fix.
Last edited by renku; 21 Sep 2011 at 3:51 AM. Reason: Updated link (JSDuck now part of senchalabs)-->
28 Dec 2010 6:09 AM #2
It looks like an interesting project. I'm surprised you went to so much work just to remove the HTML comments you're so frustrated with (IMO not worth the effort... then again, my documentation is very to-the-point).
The thing I like the most about your approach is removing the XML config file - that has been a thorn in my side for a while now.
I haven't downloaded it yet, but I'll spend some time this week playing with it.Arthur Kay
Senior Software Engineer, Sencha Inc.
Twitter | Sencha Chicago User Group
28 Dec 2010 6:15 AM #3
- Join Date
- Nov 2008
- San Diego, Peoples' Republic of California
- Vote Rating
I like the approach, but I'm not a ruby guy and don't know Jack (SIC) about it or really want to.
28 Dec 2010 8:36 AM #4I'm surprised you went to so much work just to remove the HTML comments you're so frustrated with (IMO not worth the effort...
29 Dec 2010 11:10 AM #5
given that the sencha team is working on their own jsdoc parser, I don't see the purpose of doing this, other than going through the exercise.
Last edited by mitchellsimoens; 14 Jul 2011 at 6:36 AM. Reason: JSDuck is part of Sencha, less confusion-->
29 Dec 2010 11:11 AM #6-->
30 Dec 2010 1:33 AM #7
Speaking of ext-doc, I thought several times of extending it with the functionality I wanted. I studied the source code, played around with it, etc. But in the end I felt that I had to make too many changes, so maybe it was easier to just completely re-implement the whole thing. Besides, writing Java happens to cause pain for me, I opted to have fun instead with Ruby. (Sorry, the last thing is my personal problem - no offence towards Java-guys intended.)-->
31 Dec 2010 2:21 AM #8
I've been trying to use extdoc for a long time, but didn't like the HTML comments. JsDuck was just what I needed, thanks for your excellent work!-->
3 Jan 2011 2:22 AM #9
Great, I'll definitely switch to this tool. Using Markdown instead of HTML is *soo* simpler..-->
10 Jan 2011 7:37 AM #10
I have now released another version. Almost all of ext-doc features are now implemented (only custom @tags aren't supported - and I'm unsure of how important that is).
If somebody spots any bugs, it would be great to hear. I'm sure there are some.
Additionally, now it would be a perfect time to ask for any extra features. I have some things in my todo-list, but it would be nice to hear some feedback.
Hope you enjoy it. I definitely do-->
By praline in forum Community DiscussionReplies: 5Last Post: 17 Aug 2011, 7:16 AM
By christocracy in forum Community DiscussionReplies: 170Last Post: 15 Dec 2010, 1:42 AM
By Animal in forum Ext 2.x: BugsReplies: 1Last Post: 4 Feb 2009, 3:41 AM
By Animal in forum Ext 2.x: BugsReplies: 2Last Post: 7 Oct 2008, 12:48 AM
Thread Participants: 26
- firstname.lastname@example.org (2 Posts)
- harrydeluxe (1 Post)
- reaper.br (6 Posts)
- mitchellsimoens (1 Post)
- doppelganger (3 Posts)
- zombeerose (10 Posts)
- Bulle Bas (1 Post)
- SamuraiJack1 (5 Posts)
- abe.elias (1 Post)
- arthurakay (2 Posts)
- kaigan (2 Posts)
- mschwartz (1 Post)
- Grolubao (2 Posts)
- slemmon (1 Post)
- sumit.madan (1 Post)
- FlaminPhoenix (2 Posts)
- megous (2 Posts)
- ykey (6 Posts)
- nick_p (1 Post)
- hobophobik (5 Posts)
- scottmartin (6 Posts)
- AndriiKoval (1 Post)
- marco.jahn (1 Post)
- droessner (2 Posts)
- BillHubbard (16 Posts)
- aaronransley (1 Post)