API Documentation Content Bugs

[bodyboarder20]

Very minor typo: Ext.tab.Panel

"You can remove the background of the TabBar by setting the plain property to false."

should read

"You can remove the background of the TabBar by setting the plain property to true."

[kleins]

The documentation for Ext.util.TextMetrics.getSize says: "only available on the instance returned from createInstance". In Ext 4, there is no createInstance, anymore nor is TextMetrics a singleton.

Btw, I find it quite hard to keep an overview of the bugs reported in this thread. I have to read the whole thread to see whether a bug has been reported before, and how do you know whether a bug has been fixed or not? Is there no better way/tool to organise bug reporting?

[c089]

Ext.dd.DragZone refers to events like this one:

endDrag( Event e ) : void Fired when we are done dragging the object

But they are not listed as events but as methods. So it's not clear wheter one should override them or use them as events and attach event handlers.

[wiznia]

I can't find anywhere on the documentation the config option "uses", I see in the examples that is an array of classes to use that are passed to the Ext.Loader but is not documented...
By the way, I liked the 3.x documentation page more, why have the tabpanel if you are only using one tab??

[LesJ]

I see that static methods are now marked as such... nice job

I'd like to point out that the Ext.draw.Surface.create() method is static, but it's not marked as static. Perhaps this points to a systemic issue.

I see that inheritableStatics are handled correctly, but some methods can be *both* static and instance. This is not handled (minor point).

For example, Ext.draw.Color.fromHSL(), fromString() and toHex() are both static and instance.

[tomb@ibcos.co.uk]

Hi, I stared a thread here about missing documentation in the latest online docs.

For some reason the latest docs have remove a whole bunch of classes like the Ext.grid.RowEditor

This makes overriding these classes or trying to understand the Ext inner workings a complete nightmare. Please put them back or at least add an option to toggle hidden / private classes on and off.

mberrie recommended I post the issue here and suggested it may be to do with the @ignore in the 4.0.1 sources.

Thanks

[bodyboarder20]

I am unsure if this is a problem with the way the documentation is written, or if it is a problem w/ the parser used to extract the documentation....

But for Ext.view.Table (and all things extending it), "focusRow()" shows up as "An()" in the documentation...

I suspect it is due to the use of "@cfg" vice "@param" for the method documentation.... But I havent looked into the details on exactly how the current parser expects the format to look.

[tomb@ibcos.co.uk]

root config property missing from Ext.data.TreeStore as per the sample code on Ext.tree.panel

var store = Ext.create('Ext.data.TreeStore', {
    root: {
        expanded: true, 
        text:"",
        user:"",
        status:"", 
        children: [
            { text:"detention", leaf: true },
            { text:"homework", expanded: true, 
                children: [
                    { text:"book report", leaf: true },
                    { text:"alegrbra", leaf: true}
                ]
            },
            { text: "buy lottery tickets", leaf:true }
        ]
    }
});

[renku]

Thanks to everybody for reporting. All documentation issues noted so far in this thread should be fixed by now and visible in the 4.0.2 release.

Few things to note:

Ext.dd.DragZone refers to events like this one [--] But they are not listed as events but as methods.

Indeed, the methods in DragZone are actually methods, but the wording of docs made it sound like they were events.

some methods can be *both* static and instance. This is not handled.

This does point to a systemic issue, the current doc-system assumes static and instance methods can't be with the same name. For now we'll try to handle this manually, as there are only few of such cases, but this whole thing deserves a deeper look.

For some reason the latest docs have remove a whole bunch of classes like the Ext.grid.RowEditor. This makes overriding these classes or trying to understand the Ext inner workings a complete nightmare.

Yeah. Good you brought that issue up. We'll see what we can do about it. Maybe we just have to make all private classes visible again.

[dstarr@allofe.com]

The docs for Ext.window.MessageBox.show state that the constants for buttons are of the form Ext.window.MessageBox.WHATEVER, when really those are undefined. It should be Ext.MessageBox.WHATEVER