Documentation Bugs - Ext 2.x

[tjcrowder]

Seemingly throughout the docs, I see things like this:

{@link Ext.Element Element}

...rather than an actual link to the item listed. And yet in other places, the links work fine. I don't recall this from the alpha1 docs, but it's all over the beta1 docs. The Panel.header and Panel.footer properties are examples, but again, it's a general thing.

BTW, you're doing great work on the docs, folks. Substantial improvements between alpha1 and beta1, really obvious progress.

[para]

The showGroupName config option of GroupingView is incorrectly documented in the code and does not appear in the documentation.

GroupingView.js - line 54

    /**
     * @cfg {Boolean} hideGroupedColumn True to hide the column that is currently grouped
     */
    showGroupName:true,

should read

    /**
     * @cfg {Boolean} showGroupName True to show the group header in the group title. (defaults to true)
     */
    showGroupName:true,

[mystix]

Before and after screenshots are attached along with the Layout of the td in FireBug. I can confirm the same problem with Safari, although the expander cells do not collapse completely.

BTW, the same problem happens with Ext.form.BasicForm.addBinding.

added to the list under Misc/Requests.

The doc for the GridPanel's 'cm' config says it accepts a type of 'Store' instead of 'ColumnModel'.

fixed in 2.0b1a. not added to the list.

The documentation for Ext.form.FormPanel is missing the getForm method.

fixed in SVN. not added to the list.

Ext.form.FormPanel's documentation should discuss the 'items' config option as it relates to FormPanel (see this thread). It's currently inheriting the Component documentation, which doesn't help you figure out what it's going to do with the configs and specifically how it's going to map configs to classes.

added to the list under Misc/Requests.

In the summary for Ext.form.FormPanel, I recommend adding a link to Ext.form.Action.Submit so users can readily see the format for the JSON return data for the response to the default form submission feature (which is really cool).

added to the list under Misc/Requests.

The summary for Ext.form.Action.Submit ends with:

Looks like it could be an issue related to embedded HTML or something.

added to the list under Class Ext.form.Action.

WRT the issue already listed in the main post about Ext.reg not being documented (original post), it's used in the examples (examples/layout/portal.js). Recommend either documenting it or using the longhand version in examples. ExtJS is way out in front of other frameworks in terms of the examples provided, this is merely a nit being picked.

already added to the list under Misc/Requests (Class Ext.ComponentMgr).

There are some properties and other things used in the Portal layout example (examples/layout/portal.js) that aren't documented in the API documentation (or in many cases the code):

1. Panel.body property. Looking at Panel.js, there's an accessor method for it called getLayoutTarget, but that's got a comment above it saying it's private. It's documented now in beta1.

2. ddScrollConfig (both it and its members). Seems to be used by the ScrollManager for this and that, recommend adding it either in the ScrollManager summary or to the description of the register method (or both).

3. Panel.bwrap property.

4. DragSource.proxy property.

added to the list under Examples.

Property "bodyStyle" of Ext.Panel is defined as "boolean" in documentation, should be a "String".

added to the list under Class Ext.Panel.

DisplayField : String

The underlying data field name to bind to this CombBox (defaults to undefined if mode = 'remote' or 'text' if mode = 'local')

[/QUOTE]
added to the list under Class Ext.form.ComboBox.

There are no documented events in Ext.Resizable

added to the list under Class Ext.Resizable.

In the description of the "autoLoad" property for Panel, it says:

A valid url spec according to the Updater Ext.Updater.update method. If autoLoad is not null, the panel will attempt to laod its contents immediately upon render.

fixed in 2.0b1a. not added to the list.

In the configuration options for Ext.grid.GroupingView, there is no mention of the showGroupName property. This is a very useful property and I found it in the source, the docs should reflect this too.

showGroupName:false turns off the prepending of the group column name in the groups.

So for example if you have a grid showing email messages, and you group by thread subject, by default (showGroupName:true) the group names will all start with "Thread:" or whatever your column name is.

If you set showGroupName:false, it will only show the actual grouping value unadorned.

- Jim

added to the list under Class Ext.grid.GroupingView.

requestMethod should be documented in the config section of the Ext.tree.TreeLoader class.

Values include 'POST' or 'GET'
Form submission method to be passed to the Ajax constructor.

Defaults to 'POST'

added to the list under Tree.tree.TreeLoader.

There are 3 references to the now non-existent Ext.form.Form in /branches/ext2.0/src/widgets/form/Action.js:

• Action.js line 55
• Action.js line 66
• Action.js line 76

added to the list under Class Ext.form.Action.

It seems like there is alot more config options for components than I can find in the Ext 2.0 docs. I can find many examples that uses: region, minSize, split, margins, el and contentEl. I think I have seen more too, and the advice I get if it's used in an example I should to, but it would be nice to know what these options do.. I've searched the forums and I can't find any relevant posts about it, but I've just started with Ext so I am sorry if this is something obvious I just don't get..

added to the list under Misc/Requests.

"shim" has a misspelling "opnly" -> "only"

added to the list under Class Ext.Panel.

The docs for the TabPanel contain config items that do not apply to a tab panel

1. header
2. headerAsText
3. title

Using any of these config items will have no effect as the TabPanel does not show a header and should be removed from the docs to avoid confusion.

added to the list under Class Ext.TabPanel.

In Ext.Toolbar, the "maybeArray" is badly truncated :

insertButton( Number index, Object/Ext.Toolbar.Item/Ext.Toolbar.Button (may ) : Ext.Toolbar.Button/Item
Inserts any Ext.Toolbar.Item/Ext.Toolbar.Button at the specified index.
Inserts any Ext.Toolbar.Item/Ext.Toolbar.Button at the specified index.
Parameters:

    * index : Number
      The index where the item is to be inserted
    * (may : Object/Ext.Toolbar.Item/Ext.Toolbar.Button
      be Array)} item The button, or button config object to be inserted.

added to the list under Class Ext.Toolbar.

The listeners configuration option is missing from Ext.util.Observable.

added to Class Ext.util.Observable.

Ext.data.Field is very important but it is not in the documentation.

I had to create my own notes on name, mapping, convert because none existed. Also, mapping and convert are not that useful on Array based stores since it requires you to put the field index (as opposed to the field name) in the mapping value. (Since convert uses the mapping value, it becomes equally underused. )

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

The summary for BasicForm talks about overriding the onSubmit method if you want to do a "normal" form submission, but the onSubmit method isn't documented and is marked "private" in the source.

added to the list under Misc/Requests.

Seemingly throughout the docs, I see things like this:

{@link Ext.Element Element}

...rather than an actual link to the item listed. And yet in other places, the links work fine. I don't recall this from the alpha1 docs, but it's all over the beta1 docs. The Panel.header and Panel.footer properties are examples, but again, it's a general thing.

BTW, you're doing great work on the docs, folks. Substantial improvements between alpha1 and beta1, really obvious progress.

added to the list under All Classes.

The showGroupName config option of GroupingView is incorrectly documented in the code and does not appear in the documentation.

GroupingView.js - line 54

    /**
     * @cfg {Boolean} hideGroupedColumn True to hide the column that is currently grouped
     */
    showGroupName:true,

should read

    /**
     * @cfg {Boolean} showGroupName True to show the group header in the group title. (defaults to true)
     */
    showGroupName:true,

already reported by @Jim McCabe in this post above: http://www.sencha.com/forum/showthread.php?p=72391. not added to the list.

[JeffHowden]

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.

[JeffHowden]

In JsonReader.readRecords()

Create a data block containing Ext.data.Records from an XML document.

[JeffHowden]

In /data/Connection.js:

/**
* @event requestexception
* Fires if an error HTTP status was returned from the server.
* See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>HTTP Status Code Definitions</a>
* for details of HTTP status codes.
* @param {Connection} conn This Connection object.
* @param {Object} response The XHR object containing the response data.
* See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>
* for details.
* @param {Object} options The options config object passed to the {@link #request} method.
*/

Notice that a closing quote (") is missing from the HREF attribute. This causes some very interesting issues in the docs.

[SeaSharp]

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.

[splintor]

[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...

[SeaSharp]

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"

[SeaSharp]

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.