11
Feb
08

Javascript Code Documentation

After a hard period of coding a lot of javascript, I wanted to run a code documentation tool for auto generated docu of my classes.

Therefore I used the docu tags as I found them in the sourcecode of the ExtJS library with the strong feeling that I just have to download the appropriate tool when I want to generate my docu.

Foolish me! After some hard googleing I found, that there is no such tool out. There are quite a few projects dealing with javascipt docu, but they all don’t understand the ExtJS slang.

ExtJS itself uses an internal tool, which they don’t want to publish. Luckily I found a thread in the ExtJS Forum where a user claimed to have a working solution, but also this user didn’t want to share it.

A small side-note made me hoping to find his code in the official jsdoc-toolkit project. So I searched  the projects svn repository, but w.o. success. Frustrated i began coding myself a solution. Driven by the thought, that the ExtJS Forum user must have had at least committed something to the Jsdoc-toolkit project I started my svn browser again and searched explicitly for such an commit.

Surprised I found that there must have happened some really ugly scenes in this project. With revision 476 all the work on a ExtJS compatible version where doped.

But hey, it’s SVN :-) Just checkout revision 471. I don’t dare to publish an Archive of it here, as i don’t know if there are any licensing issues. Moreover the efforts are not completed yet, but it looks really promising:

extdoc.jpg

I’ll try to contact the author and see if we can bring this to a successful end.


6 Responses to “Javascript Code Documentation”


  1. 1 Christocracy Mar 3rd, 2008 at 10:22 pm

    Yo. The author isIn: true

  2. 2 Shyru Mar 3rd, 2008 at 10:48 pm

    This looks very promising! Thanks for your work. I also replied in the original ext-thread, so this is just a heads-up.

  3. 3 nitin Mar 6th, 2008 at 11:03 am

    Where can i get the source code for ExtJS. Can u please help on this

  4. 4 Cornelius Weiss Mar 7th, 2008 at 6:07 pm

    Hi Nitin
    in the extjs tar-balls is a directory “source”. If you want to have svn access, you need to buy a service subscription. I don’t have such a thing, in my view extjs is quite ok as it comes in the releases.

    cu

  5. 5 auta ze szwecji Nov 20th, 2008 at 12:05 am

    Very interesting article, i bookmarked your blog
    Best regards

  1. 1 registered jsdoc-toolkit-ext at sourceforge at my 2 cents Pingback on Mar 4th, 2008 at 6:14 pm

Leave a Reply