Thank you for reporting this bug. We will make it our priority to review this report.
  1. #1
    Sencha User
    Join Date
    Jul 2010
    Location
    Palo Alto
    Posts
    60
    Vote Rating
    0
    nick_p is on a distinguished road

      0  

    Default API Documentation Content Bugs

    API Documentation Content Bugs


    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.
    Last edited by renku; 3 Jun 2012 at 10:04 AM. Reason: from now on, most docs bugs should get reported as comments

  2. #2
    Ext JS Premium Member
    Join Date
    Mar 2011
    Location
    Aachen, Germany
    Posts
    47
    Vote Rating
    0
    SommerEngineering is on a distinguished road

      0  

    Default


    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.

  3. #3
    Touch Premium Member
    Join Date
    Nov 2010
    Location
    Chicago
    Posts
    1,329
    Vote Rating
    118
    LesJ is a name known to all LesJ is a name known to all LesJ is a name known to all LesJ is a name known to all LesJ is a name known to all LesJ is a name known to all

      0  

    Default


    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');

  4. #4
    Ext JS Premium Member rstuart's Avatar
    Join Date
    Jan 2008
    Location
    Brisbane, Australia
    Posts
    140
    Vote Rating
    4
    rstuart is on a distinguished road

      0  

    Default


    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.

  5. #5
    Ext JS Premium Member gevik's Avatar
    Join Date
    May 2009
    Location
    The Netharlands
    Posts
    265
    Vote Rating
    8
    gevik will become famous soon enough

      0  

    Default Ext.chart.series.Bar missing doc tags

    Ext.chart.series.Bar missing doc tags


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

  6. #6
    Sencha User
    Join Date
    Sep 2010
    Posts
    27
    Vote Rating
    0
    Allan Stark is on a distinguished road

      0  

    Default


    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>

  7. #7
    Sencha User renku's Avatar
    Join Date
    Feb 2009
    Location
    Estonia
    Posts
    437
    Vote Rating
    17
    renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold

      0  

    Default


    Quote Originally Posted by gevik View Post
    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.

  8. #8
    Ext JS Premium Member gevik's Avatar
    Join Date
    May 2009
    Location
    The Netharlands
    Posts
    265
    Vote Rating
    8
    gevik will become famous soon enough

      0  

    Default


    Quote Originally Posted by renku View Post
    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.

  9. #9
    Sencha User renku's Avatar
    Join Date
    Feb 2009
    Location
    Estonia
    Posts
    437
    Vote Rating
    17
    renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold

      0  

    Default


    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.

  10. #10
    Ext JS Premium Member gevik's Avatar
    Join Date
    May 2009
    Location
    The Netharlands
    Posts
    265
    Vote Rating
    8
    gevik will become famous soon enough

      0  

    Default


    Quote Originally Posted by renku View Post
    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....

Thread Participants: 168

  1. Lod (1 Post)
  2. mystix (3 Posts)
  3. Juanito (1 Post)
  4. GArrow (1 Post)
  5. adarsh_r_bhat (2 Posts)
  6. pbb72 (2 Posts)
  7. rex.staples (1 Post)
  8. rednix (1 Post)
  9. hendricd (1 Post)
  10. dogomatic (1 Post)
  11. richard.allen (1 Post)
  12. ValterBorges (4 Posts)
  13. cnelissen (1 Post)
  14. neshaug (1 Post)
  15. richardtallent (1 Post)
  16. Hemlock (2 Posts)
  17. pbienick (3 Posts)
  18. mankz (8 Posts)
  19. rstuart (1 Post)
  20. Ant1105 (1 Post)
  21. NOSLOW (1 Post)
  22. crysfel (1 Post)
  23. carl23934 (1 Post)
  24. zombeerose (19 Posts)
  25. Allwise (1 Post)
  26. themightychris (1 Post)
  27. SamuraiJack1 (1 Post)
  28. wildfire (1 Post)
  29. Qtx (4 Posts)
  30. wiznia (3 Posts)
  31. Greendrake (1 Post)
  32. charleshimmer (1 Post)
  33. chdig (1 Post)
  34. Jaitsu (1 Post)
  35. Dumas (1 Post)
  36. janhov (3 Posts)
  37. edspencer (7 Posts)
  38. firefoxSafari (1 Post)
  39. cstrong@arielpartners.com (1 Post)
  40. renku (75 Posts)
  41. westy (1 Post)
  42. slemmon (3 Posts)
  43. gevik (10 Posts)
  44. bodyboarder20 (4 Posts)
  45. ZachG (3 Posts)
  46. kleins (1 Post)
  47. campersau1 (5 Posts)
  48. 44gatti (1 Post)
  49. batweasel (1 Post)
  50. fguest (1 Post)
  51. drogers (1 Post)
  52. wsi (1 Post)
  53. ironandsteel (1 Post)
  54. McQuack_82 (1 Post)
  55. Uberdude (1 Post)
  56. hhangus (3 Posts)
  57. hexawing (4 Posts)
  58. chinabuffet (2 Posts)
  59. Ozone (2 Posts)
  60. tomb@ibcos.co.uk (5 Posts)
  61. olivierpons (1 Post)
  62. flanders (2 Posts)
  63. wufpack_jack (1 Post)
  64. devtig (1 Post)
  65. aghextjs (1 Post)
  66. WBX (1 Post)
  67. alonweiss (4 Posts)
  68. yakovsh (1 Post)
  69. gianmarco (3 Posts)
  70. halcwb (5 Posts)
  71. ykey (1 Post)
  72. korax (1 Post)
  73. zerkms (2 Posts)
  74. keithhackworth (2 Posts)
  75. eliotik (1 Post)
  76. h.wagner@telekom.de (1 Post)
  77. nosferatum (2 Posts)
  78. wbutler (1 Post)
  79. dancha (1 Post)
  80. Jan (HL) (2 Posts)
  81. touchy (1 Post)
  82. charris (2 Posts)
  83. Allan Stark (1 Post)
  84. vadimv (7 Posts)
  85. rhamflett (1 Post)
  86. Evantan (4 Posts)
  87. kent78 (1 Post)
  88. jhummel (1 Post)
  89. fishbone (1 Post)
  90. skirtle (35 Posts)
  91. LesJ (43 Posts)
  92. mangotang (2 Posts)
  93. Felicitus (1 Post)
  94. tiger.seo (3 Posts)
  95. clearbasis (1 Post)
  96. sreeser (1 Post)
  97. Rob Hogan (3 Posts)
  98. SebTardif (6 Posts)
  99. mberrie (4 Posts)
  100. rijkvanwel (1 Post)
  101. s.busch (1 Post)
  102. Nickname (4 Posts)
  103. dstarr@allofe.com (4 Posts)
  104. m4dc4p (1 Post)
  105. fdp (2 Posts)
  106. SommerEngineering (1 Post)
  107. mprogr (1 Post)
  108. Berzzzebub (2 Posts)
  109. Justin Noel (2 Posts)
  110. S├ębastien.Volle (2 Posts)
  111. sskow200 (1 Post)
  112. jobjo (1 Post)
  113. cadror (2 Posts)
  114. c089 (2 Posts)
  115. ligaard (29 Posts)
  116. neonova (2 Posts)
  117. jonathanmv (1 Post)
  118. nbabinski (4 Posts)
  119. Vasiliy Faronov (2 Posts)
  120. mrobinson (1 Post)
  121. ext-spring-mvc (1 Post)
  122. rexmpetersen (1 Post)
  123. BillHubbard (5 Posts)
  124. redraid (1 Post)
  125. Arshak (2 Posts)
  126. espeak (1 Post)
  127. Farish (2 Posts)
  128. nohuhu (1 Post)
  129. dwarf (1 Post)
  130. burnnat (12 Posts)
  131. don@electionmall.com (1 Post)
  132. sirtmp (1 Post)
  133. Jasel_ExtJS (1 Post)
  134. dusek (1 Post)
  135. bioinfo (1 Post)
  136. dpaquin (1 Post)
  137. nhoward (1 Post)
  138. Wilkins (1 Post)
  139. flatbugz (1 Post)
  140. tonyx (1 Post)
  141. eirik.lorentsen (1 Post)
  142. limscoder (1 Post)
  143. ExtJSNinjas (2 Posts)
  144. castitas (7 Posts)
  145. nealtao (1 Post)
  146. mark0978 (7 Posts)
  147. olecom (2 Posts)
  148. JimSoper (1 Post)
  149. hnordt (1 Post)
  150. WingC (2 Posts)
  151. cawoodm (1 Post)
  152. jchristen (1 Post)
  153. carrollecc (1 Post)
  154. p33t (5 Posts)
  155. user ext (1 Post)
  156. JeromeA (1 Post)
  157. mikfreeman (1 Post)
  158. DrewM (1 Post)
  159. Lascaux (1 Post)
  160. einartg (2 Posts)
  161. colin.yates (1 Post)
  162. atomcat (1 Post)
  163. Ghostly (2 Posts)
  164. bomslang (1 Post)
  165. wayne_x (1 Post)
  166. mpost (1 Post)
  167. jreusser (1 Post)
  168. ckerth (1 Post)