API Documentation Content Bugs

**nick_p** · 27 May 2011 9:59 AM

To report any typos, inconsistencies, missing or incorrect documentation, please post them as comments directly to the documentation.

Only if it doesn't seem to fit to the comments format, but is still about documentation, post it here.

If you are having issues with the Docs application as opposed to the content, report your bugs to JSDuck thread or directly to github bug tracker.

**SommerEngineering** · 29 May 2011 5:07 AM

In Ext.form.RadioGroup the example at the beginning is wrong:

Code:

var myRadioGroup = new Ext.form.RadioGroup({
    id: 'myGroup',
    xtype: 'radiogroup',
    fieldLabel: 'Single Column',
    // Arrange radio buttons into three columns, distributed vertically
    columns: 3,
    vertical: true,
    items: [
        {boxLabel: 'Item 1', name: 'rb', inputValue: '1'},
        {boxLabel: 'Item 2', name: 'rb', inputValue: '2', checked: true},
        {boxLabel: 'Item 3', name: 'rb', inputValue: '3'}
        {boxLabel: 'Item 4', name: 'rb', inputValue: '4'}
        {boxLabel: 'Item 5', name: 'rb', inputValue: '5'}
        {boxLabel: 'Item 6', name: 'rb', inputValue: '6'}
    ]
});

There are missing commas:

Code:

var myRadioGroup = new Ext.form.RadioGroup({
    id: 'myGroup',
    xtype: 'radiogroup',
    fieldLabel: 'Single Column',
    // Arrange radio buttons into three columns, distributed vertically
    columns: 3,
    vertical: true,
    items: [
        {boxLabel: 'Item 1', name: 'rb', inputValue: '1'},
        {boxLabel: 'Item 2', name: 'rb', inputValue: '2', checked: true},
        {boxLabel: 'Item 3', name: 'rb', inputValue: '3'},
        {boxLabel: 'Item 4', name: 'rb', inputValue: '4'},
        {boxLabel: 'Item 5', name: 'rb', inputValue: '5'},
        {boxLabel: 'Item 6', name: 'rb', inputValue: '6'}
    ]
});

But also with commas, this example do not work at all for me.

In Ext.panel.Panel in the description of the function animate there is a "the the" in the text.

**LesJ** · 29 May 2011 6:52 AM

I wanted to point out that there's no listview widget in Ext 4.

The inline code example is also not correct.

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

Code:

// retrieve all gridpanels and listviews
var gridsAndLists = Ext.ComponentQuery.query('gridpanel, listview');

**rstuart** · 30 May 2011 1:47 AM

In Ext.layout.container.Card, getPrev() says it returns Ext.Component. When there is no previous item, it returns a Boolean. I (as I assume most) would assume it returns undefined when there is no previous item. Instead, it returns false.

**gevik** · 30 May 2011 2:00 AM

The Ext.chart.series.Bar's class documentation is missing the @class and @extends tags in the comment!

**Allan Stark** · 30 May 2011 3:38 AM

Grid sample from API Docs (4.0.0 or 4.0.1) not working, in FF 4.0.1 (FireBug) see:

The headers config is not supported. Please specify columns instead.
msg: "The headers config is not supported. Please specify columns instead."
sourceClass: "Ext.panel.Table"
sourceMethod: "initComponent"

Sample page (all path are right and accessible):

Code:

<html>
<head>
    <title>GRID Demo</title>
    <link rel="stylesheet" type="text/css" href="ext/resources/css/ext-all.css">
    <script type="text/javascript" src="ext/ext-all-debug.js"></script>
    <script type="text/javascript">
        Ext.onReady(function() {

            Ext.regModel('Teams', {
                fields: ['name', 'sport']
            });

            var teamStore = new Ext.data.Store({
                model: 'Teams',
                sorters: ['sport','name'],
                groupField: 'sport',
                data: [
                    { name: 'Aaron', sport: 'Table Tennis' },
                    { name: 'Aaron', sport: 'Football' },
                    { name: 'Abe', sport: 'Basketball' },
                    { name: 'Tommy', sport: 'Football' },
                    { name: 'Tommy', sport: 'Basketball' },
                    { name: 'Jamie', sport: 'Table Tennis' },
                    { name: 'Brian', sport: 'Basketball' },
                    { name: 'Brian', sport: 'Table Tennis' }
                ]
            });

            var grid = new Ext.grid.Panel({
                renderTo: Ext.getBody(),
                store: teamStore,
                width: 400,
                height: 300,
                title: 'Sports Teams',
                features: [{
                    ftype: 'grouping'
                }],
                headers: [{
                    text: 'Name',
                    flex: 1,
                    dataIndex: 'name'
                },{
                    text: 'Sport',
                    dataIndex: 'sport'
                }]
            });

        });
    </script>
</head>
<body></body>
</html>

**renku** · 30 May 2011 6:02 AM

Originally Posted by gevik

The Ext.chart.series.Bar's class documentation is missing the @class and @extends tags in the comment!

But the documentation is still correct, isn't it

That's because we're now using JSDuck to generate the docs, which doesn't require having @class and @extends if these can be implied from source.

**gevik** · 30 May 2011 1:46 PM

Originally Posted by renku

But the documentation is still correct, isn't it

That's because we're now using JSDuck to generate the docs, which doesn't require having @class and @extends if these can be implied from source.

That is correct

But it is inconsistent. If we are using @ tags to document the code-base then we should do it correctly for the sake of quality and minimize the risk of having to implement edge cases in JSDuck.

**renku** · 31 May 2011 12:59 AM

Sure, the formatting of doc-comments is currently inconsistent in several areas, but we're transitioning towards more light-weight markup for the comments - using Markdown for formatting and not repeating in comments what JSDuck can easily extract from the code.

**gevik** · 31 May 2011 2:15 AM

Originally Posted by renku

Sure, the formatting of doc-comments is currently inconsistent in several areas, but we're transitioning towards more light-weight markup for the comments - using Markdown for formatting and not repeating in comments what JSDuck can easily extract from the code.

To be honest I doubt using a Markdown-only solution would work. Since JS is an untyped language, no JS parser is able to determine the actual member type (int,bool,string etc) unless there is another mechanism ( @ tags then) to describe a class member.

All I'm trying to say is: since there has been a major overhaul of the code-base, why not decide on a uniform syntax for describing class members... Reviewing the code comments to make them consistent does not cost that much, right?

It is unfortunate that Sencha doesn't accept patches from the community anymore, Otherwise I could have send you corrections along the way. Because of Ext4Yii I am examining the code-base file-by-file.

my2cents.... anyway....

API Documentation Content Bugs

Thread Tools

Search Thread

Display

API Documentation Content Bugs

API Documentation Content Bugs

Ext.chart.series.Bar missing doc tags

Ext.chart.series.Bar missing doc tags