Re: Widget reference

David Crawshaw <[email protected]> Thu, 1 Jan 2004 13:00:11 +1000
Newsgroups gmane.comp.java.xwt.widgets
Message-ID <[email protected]>
On 01/01/2004, at 12:43 PM, Charles Goodwin wrote:
> I'd like to start maintaining a widget reference, because we need an
> explanation of the widgets, the widgets' API, and theming widgets.

I was thinking about this about a week ago and I don't think it's the 
right time to write such a document.

The explanation of the widgets and their API should really be in the 
.xwt files in the cvs. Inline docs are a PITA, because it means every 
time you change something you have to update the docs. The wonderful 
thing about them is, every time you change something you have to update 
the docs. :)

Eventually, our API documentation should be generated (a la JavaDoc) 
from these docs, with some diagrams thrown in. Then we need some 
tutorials for people starting out with the widget library. I believe 
that + XWT Core Reference is all we really need.

The concept of a reference is really for a system (ie XWT Core), not an 
API.

d