If you look in cvs you will find the config files to build the docs using doxygen. This was done once before and is easy to setup.
Rob On 11/15/2001, Doug Melvin wrote: > Now this looks kinda good.. > What kind of constraints does it place on coding style (if any) ? >> Oxygen is really cool, works in windows, or Linux. It's touted for C C++, >> but with a little tweaking will work ok with Javascript. >> sample output: >> http://www.richardinfo.com/examples/Richardinfo_Developer_Docs/ >> >> http://www.stack.nl/~dimitri/doxygen/index.html. >> >> >> Cheers, >> Richard. >> >> >> >> >> >> ----- Original Message ----- >> From: "Laszlo Teglas" <[EMAIL PROTECTED]> >> To: <[EMAIL PROTECTED]> >> Sent: Wednesday, November 14, 2001 11:41 PM >> Subject: RE: [Dynapi-Dev] Documentation Project >> >> >> > I thought about this myself. I like the idea since this would document > our >> > code as well as create the html docs. >> > >> > This has two downsides however: >> > 1) In Java you can afford to comment your source as much as you like, >> > because the compiler strips out the comments, and your comments don't >> affect >> > the file size and performance of the byte code. In JavaScript however we >> > have to be conscious of the size of our source comments, as they are not >> > striped out before they are downloaded. Thus this effects performance >> > >> > 2) You have to build a doc compiler. This is a project of its own. I > don't >> > think we have the resources for that. >> > >> > NanoFace =;^) >> > >> > -----Original Message----- >> > From: Matt Fair [mailto:[EMAIL PROTECTED]] >> > Sent: November 14, 2001 4:39 PM >> > To: Laszlo Teglas >> > Cc: [EMAIL PROTECTED] >> > Subject: RE: [Dynapi-Dev] Documentation Project >> > >> > >> > Are we thinking of puting together source documentation like what java >> > has with its javadocs? >> > A javadoc style would be: >> > /** >> > I put my documentation here for this method >> > example: foo bar >> > */ >> > FooBar.prototype.foo=function() { >> > ... >> > } >> > >> > We could put together a web-based documentation compiler. >> > >> > just some thoughts. >> > Matt >> > >> > >> > _______________________________________________ >> > Dynapi-Dev mailing list >> > [EMAIL PROTECTED] >> > http://www.mail-archive.com/[email protected]/ >> > >> >> >> _______________________________________________ >> Dynapi-Dev mailing list >> [EMAIL PROTECTED] >> http://www.mail-archive.com/[email protected]/ >> > _______________________________________________ > Dynapi-Dev mailing list > [EMAIL PROTECTED] > http://www.mail-archive.com/[email protected]/ _______________________________________________ Dynapi-Dev mailing list [EMAIL PROTECTED] http://www.mail-archive.com/[email protected]/
