Documentation Bugs - Ext 2.x

[rednix]

In the online Ext 2.0 - API Documentation:

ComponentMgr > Public Methods > get

Returns:

    * void

As stated in Ext.getCmp( String id ) : Ext.Component

Shorthand for Ext.ComponentMgr.get

the get method of ComponentMgr doesn't return void but Ext.Component!

[mystix]

There seems to be a parsing problem with Updater.update().

update( Object/String/Function url, [String/Object params], [Function callback], [Boolean discardUrl] ) : void
Performs an asynchronous request, updating this element with the response. If params are specified it uses POST, othe...
Performs an asynchronous request, updating this element with the response. If params are specified it uses POST, otherwise it uses GET.

NB: Due to the asynchronous nature of remote server requests, the returned data will not be available to the line immediately following the load() call. To process the returned data, use the callback option, or an {@link #event-update update} event handler.

added to the list under Class Ext.Updater.

In JsonReader.readRecords()

added to the list under Class Ext.data.JsonReader.

In /data/Connection.js:
...
Notice that a closing quote (") is missing from the HREF attribute. This causes some very interesting issues in the docs.

added to the list under Class Ext.data.Connection.

A search for "inputValue" in the documentation system returns two results form.Checkbox and form.Radio. However there is no definition for the "inputValue" attribute in either case.

added to the list under Class Ext.form.CheckBox and Class Ext.form.Radio.

[2.0b1] Here is a code snippet from GridPanel.js:

/**
* @cfg {Boolean} trackMouseOver True to highlight rows when the mouse is over. Default is false.
*/
trackMouseOver : true,

I think the problem speaks for itself...

added to the list under Class Ext.gid.GridPanel.

In the online Ext 2.0 - API Documentation:

ComponentMgr > Public Methods > get

Returns:

    * void

As stated in Ext.getCmp( String id ) : Ext.Component

Shorthand for Ext.ComponentMgr.get

the get method of ComponentMgr doesn't return void but Ext.Component!

added to the list under Class Ext.ComponentMgr.

It would be nice if the online documentation system reported its minor version number in the top of page banner. This was the reason for my doc bug report above not having a version in the title.

Something like "Ext 2.0 (beta 1) - API Documentation"

added to the list under Misc/Requests.

Someone else mentioned that getForm() is missing but the contained BasicForm seems to be available as a public property as well but this is not documented.

Ext.form.FormPanel's getForm method is already documented in SVN.
since the method getForm is a public accessor, i would think that the form property is a private one.
nevertheless, i've added this (i.e. the missing form property) to the list under Class Ext.form.FormPanel just in case.

[rednix]

Just another minor online Ext 2.0 Documentation bug:

The type of the config parameter bodyStyle of the Ext.Panel class is described as Boolean. That's not correct because this config parameter accepts the same format as Ext.Element.applyStyles - and that's String/Object/Function.

[mystix]

Just another minor online Ext 2.0 Documentation bug:

The type of the config parameter bodyStyle of the Ext.Panel class is described as Boolean. That's not correct because this config parameter accepts the same format as Ext.Element.applyStyles - and that's String/Object/Function.

added to the list under Class Ext.Panel.

[para]

Ext.tree.TreePanel
loader : Boolean
A TreeLoader for use with this TreePanel

[mystix]

Ext.tree.TreePanel
loader : Boolean
A TreeLoader for use with this TreePanel

the current 2.0 docs are already showing "loader: Ext.tree.TreeLoader", and the 1.1.1 docs have already been fixed in SVN.

not added to the list.

[mscdex]

In the description for the "elements" config option for Ext.Panel, there is a typo in the last line: Valid values are: 'header,' 'body,' 'footer,' 'tbar' (top bar) abd 'bbar' (bottom bar) - defaults to 'body.'

[mystix]

In the description for the "elements" config option for Ext.Panel, there is a typo in the last line: Valid values are: 'header,' 'body,' 'footer,' 'tbar' (top bar) abd 'bbar' (bottom bar) - defaults to 'body.'

added to the list under Class Ext.Panel.

[splintor]

In the html config option of Ext.Window, DomHelper link is not resolved:

An HTML fragment, or a {@link Ext.DomHelper DomHelper} specification to use as the panel's body content (defaults to '').

BTW, the help system can be improved so it is possible to build diret links to a config option, property or method. I would think something like http://extjs.com/deploy/dev/docs/?cl...xt.Window-html would work, but it doesn't. It seems to put the page in an eternal "Loading" mode.

[mystix]

In the html config option of Ext.Window, DomHelper link is not resolved:

An HTML fragment, or a {@link Ext.DomHelper DomHelper} specification to use as the panel's body content (defaults to '').

jack has fixed the document parser so this problem shouldn't appear in the next revision.
not added to the list.

BTW, the help system can be improved so it is possible to build diret links to a config option, property or method. I would think something like http://extjs.com/deploy/dev/docs/?cl...xt.Window-html would work, but it doesn't. It seems to put the page in an eternal "Loading" mode.

added to the list under the Misc/Requests section.