>- javadoc commenting of plug-in external interface

Using what tool? jsDoc?
I've found that jsDoc works great for class-based structures, but not so well 
for stand-along functions or library interfaces like jquery plugins. There 
should be some standard javadoc-style syntax, but not necessarily exactly as 
used in jsdoc.

In any event, I think all plugins should certainly have embedded API 
documentation, and the jquery.com site itself should be able to present each 
plugin's API docs in the same format, using the same tool.

I would also suggest implementing additional jquery-specific doc tags for 
dependencies, etc.

I've yet to find a tool that I really like to parse and report on these 
javadoc-style tags with the flexibility that I want. I don't even want a js 
parser - I can provide the full documentation, function name, parameters, etc 
within my comments. So I started writing a tool in php that will output the 
documentation on-the-fly. Of course, it's about 10% done, like most things I 
start...

Matt


_______________________________________________
jQuery mailing list
discuss@jquery.com
http://jquery.com/discuss/

Reply via email to