hi, I presume it's a little quite around the documentation topic because everyone's busy writing the docs :o)
I did some testing on Doxygen. I don't think it's feasible to update two versions of our source-code, and to be honest, the docs generated from the Java version of our source code did not actually help me understand the DynAPI, because I'm not so familiar with the Java syntax. So I did a test to see if we could us Doxygen to create documentation from our standard commented source-code. For those wanting constructor/destructor and Java::syntax it might be disappointing, to me it looks readable for Javascript coders. I just did the DynObject part of dynapi.js, and I tried all Doxygen syntax that we could use, so not all comments are genuine - some are simply to test the output. I did 3 manual edits to create this, all the rest is done automatically. Have a look at this: http://www.richardinfo.com/examples/apiNew/ or if the redirect is slow: http://www.your-site.com/~rinfo//examples/apiNew/ This is the frames version, the same code can be used without frames, using the page-top menu: http://www.your-site.com/~rinfo//examples/apiNew/main.html the two main sections are the source code: http://www.your-site.com/~rinfo//examples/apiNew/dynapi_8js-source.html and the documentation: http://www.your-site.com/~rinfo//examples/apiNew/dynapi_8js.html What I want to know is, if this looks like it could be of use to people learning the DynAPI source code, if so, I'll write some documentation on using Doxygen with DynAPI, so the commenting can be done in the same style, by various list members. If not, then I think we'd best simply comment the dynapi source-code clearly, and use that as documentation. Some feedback on this would be great... Cheers, Richard. _______________________________________________ Dynapi-Dev mailing list [EMAIL PROTECTED] http://www.mail-archive.com/[email protected]/
