Do you mean more readable than the jQuery API docs (jquery.com/api/) ?
 I find that to be quite nice actually.  If you mean that's what you
want, then all the handy tools you need are available in the SVN
repository.  When you perform an

ant docs
or
make docs

at the command line inside the jquery folder, it will build the XML
documentation based on the comments in the code. I'm not sure of all
of the available options for that syntax either, but you can probably
get pretty much all you'll need by looking at the source comments and
comparing that to what comes out after the above commands.  If you
want to create docs for your own plugin, just comment it up
appropriately and include it in the "PLUGINS_ALL" property in the
build.xml file (if you're using ant).  It's all fairly confusing if
you're unfamiliar with build tools like ant, but some trial and error
and beer should get you through it ok.  I'm sure John or Yehuda will
be able to do a much better job explaining, but I figured I might be
able to get you started.

Hope this helped,

Paul

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

Reply via email to