>You may have misunderstood my post. Yes, I did. My apologies =;^) >so the question is, is documentation that looks like this: > http://www.your-site.com/~rinfo//examples/apiNew/dynapi_8js.html >In a usable format or not. (Bear in mind that I tried every available >command, so the output is not particularly logical - this was a test.) >... >Doxygen is an opensource project, so if we need tweaking, that shouldn't be >a problem. Yes it looks definitely usable. And since you were able to make it work with our original src, it would cut down on a lot of the work. This however only yields the functions as I suspected. I would have preferred to be able to categorize them according to their use. (constructor, public method, private method) However in the name of getting it done ASAP, I can live with this type of reference. We can always tweak it later as you suggested.
>If you'd rather work out the documentation structure and setup by your self, >and have people participate when you've got it started, let me know, and >I'll get on with other things in the meantime. My Document structure is broken into 4 modules (intro, reference, examples, tutorials). What you are doing with doxygen is the reference module and could directly plug into the overall documentation project as is. So feel free to continue as you started, I will work on the other modules then, and the interface to tie them together. Being able to use doxygen on the JS src, certainly cuts down on our work. One request I have for future consideration: If it does not interfere with doxygen, I would still like to use the following commenting style +/- what the community agrees on. Since in the future we might be inclined to build our own doc generator or tweak doxygen to take advantage of these additional commands, so we can enjoy a more complete reference doc: What every file should begin with: /** * DynAPI Distribution * The DynAPI Distribution is distributed under the terms of the GNU LGPL * license. * * @class DynLayer * @package dynapi.api * @file DynLayer.js * @version v1.71 * @date Sun Nov 11 16:25:18 2001 UTC * @inherit DynObject * @purpose The DynLayer is the standard class used to manipulate "layers". * @bug [optional keyword] any known issues * @author [optional keyword] for personal extentions */ What every function block should be preceded with: /** * @method (public|private) | @constructor | @property (public|private) * @deprecated [optional keyword] * @syntax setClip(int top,int right,int bottom,int left) * @usage some text describing the function or property * @param top (int|sring|array|object)[optional keyword] some description text. * @param right (int|sring|array|object) [optional keyword] some description text. * @param bottom (int|sring|array|object) [optional keyword] some description text. * @param left (int|sring|array|object) [optional keyword] some description text. ... */ If the @ symbol will confuse doxygen, than maybe we can temporally replace our added features with a different symbol. Just a thought. NanoFace =;^) _______________________________________________ Dynapi-Dev mailing list [EMAIL PROTECTED] http://www.mail-archive.com/[email protected]/
