PDA

View Full Version : Bad code docs -> messed up ext-doc



gevik
15 Dec 2010, 11:39 AM
In the following components the code documentation of @cfgs is not consistent which results ext-doc to generate faulty data:

1. Ext.ux.Reorderer
2. Ext.layout.boxOverflow.Scroller

the cfg doc format should be:



/**
* @cfg {Boolean} animate
*/
and not:



/**
* @cfg animate
* @type Boolean
*/

steffenk
15 Dec 2010, 5:17 PM
there are several places like this. Also indenting, spacing etc is not consistent. It should be easy to fix as most modern IDEs come with code formatters doing a great job, eg in phpStorm.