Documenting Core/Plugin APIs

1 view
Skip to first unread message

John Resig

unread,
Aug 27, 2007, 4:12:55 AM8/27/07
to jquer...@googlegroups.com, jque...@googlegroups.com, jquer...@googlegroups.com
Hi Everyone -

I took the time this evening to write up how to document your APIs
using the new wiki documentation system that I developed. Almost
everything is squared away (with the exception of examples, which
still need a little love). But at the very least, things should be
good enough to get started.

Here's the full tutorial:
http://docs.jquery.com/How_to_write_API_documentation

Here's an example of a converted plugin that's using this new style:
http://docs.jquery.com/Plugins/Calendar/calendar

(There's some weird {{{3}}} errors in the calendar page that I haven't
hunted down yet... hmm...)

Obviously the stylesheet still needs a lot of love, and I'm sure the
docs are pretty rough too (it's 4am here). But I hope this is enough
to get everyone started, for the time being. Feedback appreciated.

--John

Reply all
Reply to author
Forward
0 new messages