Hmm, I'm only a half-peon contributor but I think I remember hearing about or looking at the jsdoc project. Wouldn't that be cool, to just be bumping along in your code, modifying things and dropping some comments, and click a button and generate new docs that are up to date? That would really combat the doc lag problem. Of course, you still have to comment your code at some level, which takes time, energy and discipline. :p Sounds like a good idea though, and something I could help with, if only involved moving text from the current docs back into the source. But I might not know if the docs are /correct/. That could be easily tackled as a separate problem though, first convert, then correct. Ideally it'd be done in one go. But if it takes the first step to motivate someone to do the second step, then it'd be worth it in the end IMO. But, eh, what about custom formatting of the webpages and such? Can the JSDoc treat comments as sort of a "database" entry, allowing tokens and their values to be assigned to variables, and then use templates to replace with the variables and values? And what about the ASP (JScript and VBScript), Perl, PHP, (TCL, Scheme, Java, etc.) sources for the server-side scripts like IOElement and SODA? Can JSDoc support other comment structures, like Perl's '#'?
Leif ----- Original Message ----- From: "Rob Butler" <[EMAIL PROTECTED]> To: <[EMAIL PROTECTED]> Sent: Wednesday, June 09, 2004 9:27 PM Subject: [Dynapi-Dev] Suggestions > Hello, > > Dynapi 3.0 looks real nice. I hope to use it in a variety of open source & > commercial projects that I will be developing shortly. I hope to contribute > back to the Dynapi project as well. On that front I have a few suggestions. > > I really like having a Javascript compressor and it's great to see you have > implemented one in Java. It would be great if the compressor could be > extended to be an ant task as well as a stand alone executable. Instead of > just wrapping the existing Java class as an ant task, I would recommend > building the ant task to work in the "ant way" in that it doesn't use a > separate config file, and accepts parameters & settings from the ant script. > If I get some spare time between my other projects I could potentially help > with this, but I just wanted to get the thought out there if someone else > wanted to run with it. > > Regarding the Javascript compressor, I think it's pretty neat how you have > it doing runtime inclusion / exclusion of scripts in a single file instead > of needing to pull in multiple smaller files. However, I think the larger > file size is probably more of a negative than the separate small files. > Browsers are pretty well optimized for pulling in lots of little files > because everything on the web is a separate small file. I just point this > out because if an ant based Javascript compressor were built I think this > feature could be left out without too much of a negative impact compared to > the existing applications featureset. > > Like most open source projects the documentation in Dynapi seems to be > lagging the code's capabilities. I was considering developing my own API > similar to Dynapi (thanks for saving me a ton of work) and knew > documentation would be difficult to keep up with, and being a Java developer > I really like JavaDoc. So I looked for a Javascript Javadoc tool and found > one: http://jsdoc.sourceforge.net/ This tool is written in Perl (which is > ok, I would just prefer Java so it could be an Ant task without wrapping a > separate perl module). Perhaps Dynapi could adopt using this tool to > document it's internals? I would also be interested in developing a Java > based ant task to do Javascript Javadoc generation. Perhaps if you all > think it is a good idea to use this tool, we could contact the JSDoc > developers and see if they would be interested in developing a Java port of > their tool as an ant task. Perhaps JSDoc & Dynapi could join forces since > both groups are obviously interested in Javascript, and both have developed > a Javascript "build time" tool that compliment each other? > > Just some thoughts. Looking forward to doing good things with / > contributing to Dynapi. > > Later > Rob > > > > > ------------------------------------------------------- > This SF.Net email is sponsored by: GNOME Foundation > Hackers Unite! GUADEC: The world's #1 Open Source Desktop Event. > GNOME Users and Developers European Conference, 28-30th June in Norway > http://2004/guadec.org > _______________________________________________ > Dynapi-Dev mailing list > [EMAIL PROTECTED] > http://www.mail-archive.com/[EMAIL PROTECTED]/ > ------------------------------------------------------- This SF.Net email is sponsored by: GNOME Foundation Hackers Unite! GUADEC: The world's #1 Open Source Desktop Event. GNOME Users and Developers European Conference, 28-30th June in Norway http://2004/guadec.org _______________________________________________ Dynapi-Dev mailing list [EMAIL PROTECTED] http://www.mail-archive.com/[EMAIL PROTECTED]/
