SamuraiJack1
3 Jun 2008, 9:57 AM
Browsing the sources, I've noticed, that they are documented inline. I mean, before every method there is a documentation for it, written with some markup rules, like this:
/**
* Slides the element into view. An anchor point can be optionally passed to set the point of
* origin for the slide effect. This function automatically handles wrapping the element with
* a fixed-size container if needed. See the Fx class overview for valid anchor point options.
* Usage:
*<pre><code>
// default: slide the element in from the top
el.slideIn();
// custom: slide the element in from the right with a 2-second duration
el.slideIn('r', { duration: 2 });
// common config options shown with default values
el.slideIn('t', {
easing: 'easeOut',
duration: .5
});
</code></pre>
* @param {String} anchor (optional) One of the valid Fx anchor positions (defaults to top: 't')
* @param {Object} options (optional) Object literal with any of the Fx config options
* @return {Ext.Element} The Element
*/
slideIn : function(anchor, o){
var el = this.getFxEl(); So, it seems that documentation that all we reading at http://extjs.com/deploy/dev/docs/ is autogenerated from sources.
Think will be more than just great, if such documentation can be autogenerated for Ext.ux namespace plugins (of course for those, which are written with those markup rules).
Comments?
/**
* Slides the element into view. An anchor point can be optionally passed to set the point of
* origin for the slide effect. This function automatically handles wrapping the element with
* a fixed-size container if needed. See the Fx class overview for valid anchor point options.
* Usage:
*<pre><code>
// default: slide the element in from the top
el.slideIn();
// custom: slide the element in from the right with a 2-second duration
el.slideIn('r', { duration: 2 });
// common config options shown with default values
el.slideIn('t', {
easing: 'easeOut',
duration: .5
});
</code></pre>
* @param {String} anchor (optional) One of the valid Fx anchor positions (defaults to top: 't')
* @param {Object} options (optional) Object literal with any of the Fx config options
* @return {Ext.Element} The Element
*/
slideIn : function(anchor, o){
var el = this.getFxEl(); So, it seems that documentation that all we reading at http://extjs.com/deploy/dev/docs/ is autogenerated from sources.
Think will be more than just great, if such documentation can be autogenerated for Ext.ux namespace plugins (of course for those, which are written with those markup rules).
Comments?