There is a section on the jQuery dev site about documenting plugins:
http://proj.jquery.com/docs/Plugins/Documenting/

However, that is about documenting them using Wiki formatting. Perhaps
there should be a guide on documenting the plugin via JavaScript
comments - i.e. like how it is done with the jQuery source code?

Maybe a generic tool that generates documentation from source would be
a good idea? So you just download it, drag your source onto it (or
supply as a parameter if command line) and then it generates XML/HTML
output. Nothing as complicated as what is used for jQuery (as it is
likely to only be a single file being worked with).

_______________________________________________
jQuery mailing list
[email protected]
http://jquery.com/discuss/

Reply via email to