Documentation Bugs - Ext 2.x

[makana]

Class: Ext.tree.TreeNode
Method: ensureVisible

It's not documented, that a callback function can be passed to this method.

[Animal]

Augh!

I just did a big catchup on this and committed changes to 21 classes in each code branch, 2.0 and 3.0 to get us up to date.

I'll go and check the documentation example suggestions thread now.

[mjlecomte]

Augh!

I just did a big catchup on this and committed changes to 21 classes in each code branch, 2.0 and 3.0 to get us up to date.

I'll go and check the documentation example suggestions thread now.

Awesome!! Are changes applied to online version 'soonish' these days? Seems like there's been changes to the online version since the 2.2 release, but I'm not sure.

[Animal]

I don't think the docs have been regenerated since the 2.2 release which is a little disappointing.

It's not as if we documenters can break clients' code! I think the docs should be regenerated frequently because they are constantly changing in response to user quiestions and misunderstandings.

[jweber]

The Date.parseDate() documentation should note that rollovers will occur if certain fields have a larger-than-expected value. These include days, months, hours, minutes, and seconds. See this thread.

[mjlecomte]

IMO the part in red is not accurate due to the code following:

/**
 * @class Ext.Button
 * @extends Ext.Component
 * Simple Button class
 * @cfg {String} text The button text
 * @cfg {String} icon The path to an image to display in the button (the image will be set as the background-image
 * CSS property of the button by default, so if you want a mixed icon/text button, set cls:"x-btn-text-icon")
 * @cfg {Function} handler A function called when the button is clicked (can be used instead of click event)
 * @cfg {Object} scope The scope of the handler
 * @cfg {Number} minWidth The minimum width for this button (used to give a set of buttons a common width)
 * @cfg {String/Object} tooltip The tooltip for the button - can be a string or QuickTips config object
 * @cfg {Boolean} hidden True to start hidden (defaults to false)
 * @cfg {Boolean} disabled True to start disabled (defaults to false)
 * @cfg {Boolean} pressed True to start pressed (only if enableToggle = true)
 * @cfg {String} toggleGroup The group this toggle button is a member of (only 1 per group can be pressed, only
 * applies if enableToggle = true)
 * @cfg {Boolean/Object} repeat True to repeat fire the click event while the mouse is down. This can also be
  an {@link Ext.util.ClickRepeater} config object (defaults to false).
 * @constructor
 * Create a new button
 * @param {Object} config The config object
 */

it doesn't matter if it's true or not, because initComponent forces it to be true:

        if(typeof this.toggleGroup === 'string'){
            this.enableToggle = true;
        }

[Condor]

The Template/XTemplate docs are still incomplete:

Ext.Template has the following config options:
compiled (Boolean): true to compile the template immediately (see compile()) (default: false)
disableFormats (Boolean): true to disable format functions in the template. If the template doesn't contain format functions, setting disableFormats to true will reduce apply time (default: false)
re (RegExp): The regular expression used to match template variables (default: matches {name}).

Ext.XTemplate has an extra config option:
codeRe (RegExp): The regular expression used to match code variables (default: matches {[expression]}).

Ext.XTemplate has also the ability to execute arbitrary code with <tpl exec="..."></tpl>

It's also worth a note that the <tpl> tag must conform to:

<tpl (for|if|exec)="value">content</tpl>

So, the following <tpl> tags are invalid:

<tpl for='.'>...</tpl>
<tpl if = "true">...</tpl>
<tpl exec="this.doSomething()" />

Finally, the Ext.Template docs demonstrate how to use format functions, but this is missing from the Ext.XTemplate docs.

[mjlecomte]

Class Ext.Template

Should the bit in red be an array instead of an object?

/**
 * Alias for {@link #applyTemplate}
 * Returns an HTML fragment of this template with the specified values applied.
 * @param {Object/Array} values The template values. Can be an array if your params are numeric (i.e. {0}) or an object (i.e. {foo: 'bar'})
 * @return {String} The HTML fragment
 * @member Ext.Template
 * @method apply
 */

[Starfall]

Ext.tree.TreeLoader events:

• I think it's better to call the second argument to event listeners not just node, but parentNode.
• beforeload event text: Extra "a", in "which specifies a node's children"
• load event text: "Fires when the node's children have been successfully loaded"

[mjlecomte]

Ext.menu.Menu

missing documentation for z-index config option

    // private
    createEl : function(){
        return new Ext.Layer({
            cls: "x-menu",
            shadow:this.shadow,
            constrain: false,
            parentEl: this.parentEl || document.body,
            zindex: this.zIndex || 15000
        });
    },

/**
 * @cfg {Number} zIndex z-index (defaults to 15000)
 */

Also, constrain is fixed to be false. Why? Conflicts with align?