ideas for 1.5 API documentation

ideas for 1.5 API documentation


I've thought about how we could reuse the existing wiki templates to
document the 1.5 style API. So basic idea so far is to just document
the initializer like usual, while documenting methods for that widget
just as normal methods, too. Though in the examples, use the
appproiate syntax.
As an example, for the accordion we'd have something like this:
UI/Accordion/accordion#options -> documents accordion([options])
UI/Accordion/activate#index -> documents accordion("activate", index)
We could start with the usual type=function for those methods, and
later modify template to support something like type="widgetfunction"
which would then automatically display the APIList as
accordion("method", arg1, arg2) instead of method(arg1, arg2).
Changing the type later should be a matter of minutes, while we are
able to reuse everything now.
Arguments and return types can be documented as usual, too. Just make
sure the examples use the right syntax. So UI/Sortables/serialize
would return a String while most others return the chain.
Thoughts?