View Full Version : Documentation Improvement
jarrednicholls
05-18-2007, 09:32 AM
I'm requesting to have an improvement in the documentation for configuration options that are set to methods. For example, the Form.submit (or really BasicForm.submit) method takes an "options" parameter. The options available are not documented, and I have to keep the source open constantly while developing, and it's extremely frustrating to have to read code while writing code. This is unacceptable. God forbid ExtJS decides to make the source closed/scrambled in the future, then we wouldn't know how to do anything because the documentation doesn't explain everything.
jack.slocum
05-18-2007, 04:49 PM
The form actions are the only ones with missing docs that I can't think of (my fault). Are there are other ones you can think of?
Animal
05-19-2007, 02:26 AM
I'm currently getting to grips with the Form stuff. I have to read code, but I don't find that offensive when someone has gone to a lot of trouble to write it for me.
I intend to contribute some documentation comments back into the code when I understand it enough.
thesilentman
05-19-2007, 01:21 PM
ColumnModel is missing it's config options, and is seems like the Grid group in general is missing config options.
Animal
05-21-2007, 01:52 PM
They are there in SVN. In the first generation I made a few syntax errors withe @cfg tags which meant that the generator did not pick them up. Hopefully next time they'll end up in the generated HTML!
jack.slocum
05-21-2007, 05:00 PM
Thanks Nige! I will generate the docs off them and let you know how they turn out.
vBulletin® v3.8.4, Copyright ©2000-2010, Jelsoft Enterprises Ltd.