haxeui icon indicating copy to clipboard operation
haxeui copied to clipboard

[Docs] Things to document (first)

Open michelkaeser opened this issue 9 years ago • 3 comments

Hi (and thanks for your TW responses)

So given I think better documentation is mandatory for this project, I'd like to suggest some topics which you could start with (personal opinion):

  • A list of all supported style properties with possible values
  • Guide how to attach xml GUI to a class (e.g. a class EditorView.hx which is declared in editor.xml). Extending XMLController is not an option, as the view is not a controller (thinking the MVC way)
  • Writing a custom theme ("CSS")

Those are just suggestions...others might be in need of other things.

I'll be working on a small (GUI) project the next few months and hope to be able to document some steps too.

Thanks & keep up the good work.

michelkaeser avatar Oct 08 '14 08:10 michelkaeser

I'll add to the write custom theme/css.

  • Documentation about each widget structure, for example, TabView have a child id of #tabButton. Right now, to know this you either have to read other css file or looking right into the source code (which is a bit of a hassle, specially when trying to make full css theme).

aaulia avatar Oct 08 '14 11:10 aaulia

Agreed on all counts... Maybe over the weekend ill get a little bit of time to add some docs and better api pages

ianharrigan avatar Oct 09 '14 12:10 ianharrigan

Speaking of MVC, is IDataSource and its relations used yet by any sort of view? If so, I must have missed it, but if they are available for use now, then their use would definitely be on the list to document first. (If they're not yet used, then ignore this comment.)

Type1J avatar Jan 06 '15 11:01 Type1J