XWT Widget Documentation
"Charles Goodwin" <charlie-wHF57V0oYf6w5LPnMra/[email protected]>
| Newsgroups | gmane.comp.java.xwt.widgets |
|---|---|
| Message-ID | <[email protected]> |
Okay, I'm getting to the point where I'm trying to add decent
documentation to the widgets. I'm working entirely in the new namespace.
:)
xwt.lib.widgetname:
<xwt>
Info: xwt.lib.widgetname
- Copyright 2003 Charles Goodwin, LGPL, see xwar-root/COPYING for details
- Assumed preapplies: preapply1, preapply2
- See xwt.widget.widgetname for usage notes and a description
- See xwt.theme.widgetname for theme implementation details
Notes:
- 'Some specific developer notes'
Tasks and Known Bugs:
- Something not yet done
...
</xwt>
xwt.theme.widgetname:
<xwt>
Info: xwt.theme.widgetname
- Copyright 2003 Charles Goodwin, LGPL, see xwar-root/COPYING for details
- See xwt.widget.widgetname for usage notes and a description
Theming:
- Some information on theming this widget
- Some more information
...
</xwt>
xwt.widget.widgetname:
<xwt>
Info: xwt.widget.widgetname
- Copyright 2003 Charles Goodwin, LGPL, see xwar-root/COPYING for details
- A detailed description of the widget
Usage:
- Parameters
param1 : true, false
A description of param1
param2 : "string1", "string2", "string3"
A description of param2
- "string1" has x effect
- "string2" has y effect
- "string3" has z effect
- Things to be careful of
- Good uses
- Bad uses, alternative widgets
Example:
...
</xwt>
I'm really waiting for Corey to come back with his work on the doc tool.
But the idea of the above is to encapsulte all the necessary information
in the correct places. Obviously, syntax is completely adaptable. The
more important issue is whether there is any information in addition to
the above.
- Charlie