API Documentation Content Bugs

[Nickname]

User spurcell discovered that Ext.DomHelper isnt available as the Docs say. [Thread]

Checked the sources and found the problem:

Ext.DomHelper does not exists in 4.0.2a, but Ext.core.DomHelper does

From the src/core/src/dom/DomHelper.js file:

Ext.ns('Ext.core');
Ext.core.DomHelper = function(){
         var tempTableEl = null,

The Online Docs source :
// http://docs.sencha.com/ext-js/4-0/so...#Ext-DomHelper

Ext.ns('Ext.core');
Ext.core.DomHelper = Ext.DomHelper = function(){ 
    var tempTableEl = null,

Checked all build files in the 4.0.2a GPL release
No results for Ext.DomHelper, but for Ext.core.DomHelper

ext-4.0.2a# fgrep Ext.DomHelper ext-all*
ext-4.0.2a# fgrep Ext.core.DomHelper ext-all*
ext-all-debug.js:Ext.core.DomHelper = function(){
ext-all-debug.js:            newNode = Ext.core.DomHelper.insertHtml(pos, el, Ext.core.DomHelper.createHtml(o));
ext-all-debug.js:            Ext.core.DomHelper.applyStyles(el, o.style);
[...]

Seems the Online Docs are not for 4.0.2a as they should or generated not from the downloadable GPL version?
Please explain how this difference between downloadable version and Docs could appear.

[ykey]

http://docs.sencha.com/ext-js/4-0/#/...til.Observable

Example uses old style parent call, could be confusing.

Employee.superclass.constructor.call(this, config)

[renku]

Seems the Online Docs are not for 4.0.2a as they should or generated not from the downloadable GPL version?Please explain how this difference between downloadable version and Docs could appear.

Indeed. The Online Docs are created from 4.0.4 release, available for support subscribers.

A lot of documentation fixes have gone in since the 4.0.2a release, so to provide these to everybody as soon as possible we decided to make such a trade-off.

Mostly all the code changes should in these point-releases should barely effect the docs, but this fix (making Ext.core.DomHelper simply an alias of Ext.DomHelper) turned out to have a larger effect (the Ext.DomHelper is missing in 4.0.2a).

Sorry for the inconvenience.

[Nickname]

Thanks for the feedback.
Maybe it would be better to explain this in the Docs? Title and Docs IndexPage says "4.0.2a API Documentation".

[dstarr@allofe.com]

The load listener for Ext.data.TreeStore doesn't override Ext.data.AbstractStore, but it does pass in different parameters. According to AbstractStore, here are the parameters it should be passing:

( Ext.data.Store this, [Ext.data.Model] records, Boolean successful, Object options )

If you look at line 53444, it is actually passing

( Ext.data.Store this, Ext.data.Model rootNode, [Ext.data.Model] records, Boolean successful)

[renku]

Thanks for reporting. It's been fixed now internally.

Also, all the other issues in this thread have been fixed or otherwise noted.

Thanks to everybody for taking the time to report.

[m4dc4p]

The onValidDrop function, defined in Ext.dd.DragSource, has the tag "onInvalidDrop" associated with it. This makes the function not show up in the API docs.

Looking at http://docs.sencha.com/ext-js/4-0/so...ragSource.html, you can see how onValidDrop has the wrong tags associated with it:

  
/**
    * An empty function by default, but provided so that you can perform a custom action    
    * after a valid drop has occurred by providing an implementation.
     ...
    * @method afterInvalidDrop
   */   
this.afterValidDrop(target, e, id);

[SebTardif]

This is not true ->

This method is not affected by the {@link #closeAction} setting which
* only affects the action triggered when clicking the {@link #closable 'close' tool in the header}

    /**
     * <p>Closes the Panel. By default, this method, removes it from the DOM, {@link Ext.Component#destroy destroy}s
     * the Panel object and all its descendant Components. The {@link #beforeclose beforeclose}
     * event is fired before the close happens and will cancel the close action if it returns false.<p>
     * <p><b>Note:</b> This method is not affected by the {@link #closeAction} setting which
     * only affects the action triggered when clicking the {@link #closable 'close' tool in the header}.
     * To hide the Panel without destroying it, call {@link #hide}.</p>
     */
    close: function() {
        if (this.fireEvent('beforeclose', this) !== false) {
            this.doClose();
        }
    },

    // private
    doClose: function() {
        this.fireEvent('close', this);
        this[this.closeAction]();
    },

[cnelissen]

In Ext.view.View (extended from Ext.view.AbstractView), for the config property deferEmptyText, it does not specify which is the default.

It currently reads:

deferEmptyText : Boolean
True to defer emptyText being applied until the store's first load

It should read something like:

deferEmptyText : Boolean
True to defer emptyText being applied until the store's first load. Defaults to true.

[edspencer]

In Ext.view.View (extended from Ext.view.AbstractView), for the config property deferEmptyText, it does not specify which is the default.

It currently reads:

deferEmptyText : Boolean
True to defer emptyText being applied until the store's first load

It should read something like:

deferEmptyText : Boolean
True to defer emptyText being applied until the store's first load. Defaults to true.

Done, thanks