[Dojo-interest] Documentation

[Alex Russell]

We've looked at Doxygen, JSDoc, and any number of other JS documentation 
alternatives. They all suck for a language that's as dynamic as 
JavaScript. We have a new doc tool in the works that should fix most of 
the issues of JSDoc and Doxygen. The new system also doesn't require 
the grotty JavaDoc syntax for writing our documentation.

I'll post back here when we have a demo up.

Regards

On Wednesday 08 March 2006 7:44 am, Yi Tan wrote:
> Hi
>
> I'm very new to dojo, and have the same problem since we are
> considering using dojo to replace our currently js framework.
>
> I have been using a versatile document generator called Doxygen
> (http://www.stack.nl/~dimitri/doxygen/<http://www.stack.nl/%7Edimitri
>/doxygen/>) for other Java and ActionScript developments for a while.
> It's an excellent tool.
>
> Since dojo developers are using JDoc comments style in the JS code. I
> just tried to use Doxygen on dojo, and it does recognise the code in
> some extent. But because OO programing in JavaScript is simulated by
> coding on prototype, Doxygen can't find out the relationship between
> source files.
>
> At least, I now have a document of dojo with files list, members list
> and colourised code. Which make my life much easir.
>
>
> If you want to have a copy of the configuration file / generated
> document, please drop me a line at: yi.tan.uk at gmail.com
>
> And I'm not a expert of doxygen, I guess it must be able to product a
> much better documentation. If you knows, please tell me.
>
> Regards,
>
> Yi
>
> On 3/7/06, Eric Segal <emsegal at weown.net> wrote:
> > Yes - I am in exactly the same situation. Dojo is fantastic, but it
> > is not really Useful (with a capital U) until someone with no dojo
> > background can pick up the library, read a couple of pages, and
> > then get it working. I appreciate all the hard work that you all
> > are doing and I am looking forward
> > to that day!
> >
> > Until then, it would be useful to me if I could just hire someone
> > for an hour or two to help me get the library installed and the
> > widgets working. Any takers?
> >
> > Eric Segal
> > (eric at datacollaborative.com)
> >
> > ----- Original Message -----
> > From: "Jochen Zimmermann" <zet4080 at gmx.de>
> > To: <dojo-interest at dojotoolkit.org>
> > Sent: Tuesday, March 07, 2006 5:28 AM
> > Subject: ***SPAM -- LOW *** [Dojo-interest] Documentation
> >
> > > Hi!
> > >
> > > I know this subject was discussed a hundred times before (I
> > > scanned the archives), but I want to share my thoughts ....
> > >
> > > I'm working for a software company in Germany and I'm looking for
> > > a JavaScript-Library to use in the project I'm working on at the
> > > moment.
> > >
> > > I found dojo and I personally think it is very good work, I
> > > really like it,
> > > especially dojo.io.bind and the "require" mechanism.
> > >
> > > Now I tried to use the widgets .... I think I must cease it and
> > > perhaps even
> > > cease the use of the toolkit because of the lack of
> > > documentation.
> > >
> > > The point is: of course I could make it with "trial and error",
> > > perhaps there is enough information in the interests group
> > > archives, and if I
> >
> > want
> >
> > > to use dojo for private purpose only I'm soure I would even enjoy
> > > it
> >
> > doing
> >
> > > it that way .... but as I want to use it on work, I just don't
> > > have time for
> > > things like that!
> > >
> > > I can't try, post in the forum, scan the archives, try again,
> > > post
> >
> > again,
> >
> > > wait again .... it's impossible to do this in a professional
> >
> > environment!
> >
> > > I really think the success of dojo in the near future will depend
> > > to
> >
> > some
> >
> > > (great) extent on the quality of the documentation .... what are
> > > all the great features worth if no one can find them?
> > >
> > > Again, I really, really like dojo and I will try to use it for
> > > one or
> >
> > two
> >
> > > more days, but I fear that I can't make progress fast enough in
> > > my
> >
> > boss's
> >
> > > opinion ....
> > >
> > > Regards,
> > > Jochen Zimmermann
> > >
> > > _______________________________________________
> > > Dojo FAQ: http://dojo.jot.com/FAQ
> > > Dojo-interest at dojotoolkit.org
> > > http://dojotoolkit.org/mailman/listinfo/dojo-interest
> >
> > _______________________________________________
> > Dojo FAQ: http://dojo.jot.com/FAQ
> > Dojo-interest at dojotoolkit.org
> > http://dojotoolkit.org/mailman/listinfo/dojo-interest

-- 
Alex Russell
alex at jot.com
alex at dojotoolkit.org BE03 E88D EABB 2116 CC49 8259 CF78 E242 59C3 9723