Page 1 of 17 12311 ... LastLast
Results 1 to 10 of 167

Thread: API Doc Issues

    Thank you for reporting this bug. We will make it our priority to review this report.
  1. #1
    Ext JS Premium Member
    Join Date
    Sep 2010
    Location
    Jyderup, Denmark
    Posts
    51

    Default API Doc Issues

    When I load up the Beta 1 API docs at:

    http://dev.sencha.com/deploy/ext-4.0...ocs/index.html

    I get this error in Firebug:

    http://dev.sencha.com/new/ext-js/4-0...=1301687827211 404 Not Found


    Also, though suggestions show up in the search box, nothing happens when I click 'em. Maybe related to the above?

  2. #2
    Sencha User
    Join Date
    Jul 2010
    Location
    Palo Alto
    Posts
    60

    Default API Doc Issues

    Please post your thoughts, ideas and bug reports regarding the Ext 4 API documentation in this thread. The old thread (14 pages) can be access here. All the issues from the old thread have been either resolved or noted.

    The new documentation app differs fundamentally from the 'old' docs. It is designed to run as a server side application, rather than locally, so that we can support features including:
    • Docs from all versions of the framework
    • Docs can be kept up to date between releases
    • Inline examples, similar to jsfiddle.net
    • Community contributions, such as commenting
    • Linked resources, including blog posts, guides and screencasts
    • Search engine crawlability
    • Integrated theming docs


    The docs released with the preview releases and beta have been a static export of this 'new' docs app and so far has not benefitted from features such as Ajax loading of content. We will address this before final release.

    One issue that has come up repeatedly in the old thread is the lack of Tabbed interface. I am working to resolve this, so stay tuned!

  3. #3
    Sencha Premium User mitchellsimoens's Avatar
    Join Date
    Mar 2007
    Location
    Gainesville, FL
    Posts
    40,451

    Default

    Not a request or anything but I didn't get a chance to say it when I was at the office... Great job on the API docs Nick!
    Mitchell Simoens @LikelyMitch
    Modus Create, Senior Fullstack Engineer
    ________________
    Modus Create is based on the model of an open source team. We’re a remote, global team of experts in our field. To find out more about the work we do, head over to our website.

    Check out my GitHub:
    https://github.com/mitchellsimoens

  4. #4
    Sencha User renku's Avatar
    Join Date
    Feb 2009
    Location
    Estonia
    Posts
    437

    Default

    This turned out a bit longer than I initially thought, so bare with me...

    Bugs found from the source of Ext 4 beta 1:

    - Ext.util.AbstractMixedCollection, Ext.data.JsonWriter, and Ext.data.BufferStore are missing a class-level doc-comment and are therefore not listed in docs.
    - data/Store.js line 813: doc-comment for a for-statement.
    - data/XmlReader.js line 170: doc-comment for private function without a name.
    - core/src/dom/CompositeElement.js line 40: doc-comments for 3 functions without a name.
    - grid/RowEditing.js line 359: two doc-comments inside a function.
    - layout/container/Border.js line 633: doc-comment for an if-statement.
    - layout/Component.js line 51: doc-comment for an if-statement.

    About the front page:

    1. When I turn "Popular classes" checkbox on, leave the front page and come back, it's still on, but all the non-popular classes are listed too.

    2. The legend lists explanations like "No documentation", "Under 15 words", etc - I know that those were meant more for internal use, to track how the documentation of each class progresses, but as the legend is already out there, why not make this completeness information public too.

    About class overview page:

    1. There is no link back to the front page. I'd suggest making the Sencha logo a link to front page. Even better: rename it to "ExtJS docs", then it's obvious it isn't a link to sencha.com.

    2. There is no obvious view-source link for the class itself. I know that the class name itself is a link to the source, but I often tend to forget that. Methods have much more intuitive link to source. If nothing else, then add a similar "view source" text under the class name that appears when you hover it.

    3. Mixins and parent classes are listed twice: once in the top toolbar and second time inside the small sidebar at right. For some classes the toolbar will contain a lot of things and on smaller resolutions (e.g. 1024px width) it doesn't all fit. So I'd suggest removing Superclasses and Mixins from the toolbar completely.

    4. Small suggestion: It would be cool if checking the "Hide inherited" would also hide inherited things in the toolbar menus and change the number, so that I could easily see how many methods a class defines by itself.

    5. "Collapse all" icon on toolbar is different than the "Collapse all" icon above class tree.

    6. Inherited or mixed in static methods shouldn't be listed. Currently it looks that statics from parent class aren't listed, but statics from mixins are. See for example Ext.Controller: it mixes in Ext.util.Observable.

    7. The config options icon looks strange to me. How is it that Class icon + Component icon = Config option icon?

    8. The red "Report a bug" link points to the old forum thread.

    But these are all just minor details - you've done a hell-of-a-good job with the docs app. And last but not least: happy birthday, Nick!

  5. #5
    Sencha Premium User
    Join Date
    Nov 2010
    Location
    Chicago
    Posts
    2,425

    Default

    The Ext.Class documentation should mention how singletons are created and provide an example.

    http://dev.sencha.com/deploy/ext-4.0...Ext.Class.html

    This forum post could be used to provide this additional info.

    http://www.sencha.com/forum/showthre...static-members

  6. #6
    Sencha User
    Join Date
    Jun 2008
    Posts
    3

    Default Object Linking

    I don't know if this was mentioned in the previous thread or not, but I thought I'd give my two cents:

    I'm using Chrome to browse this, and at least once every 5 minutes or so one of the links to another class will bring me to the class of a different URL structure. This does not happen every time, but enough that I have notepad sitting open with the correct url structure so I can copy and paste to fix.

    The correct url appears to be: http://dev.sencha.com/deploy/ext-4.0-beta1/docs/api/...
    The url I'm sometimes sent to: http://dev.sencha.com/new/ext-js/4-0/api/

    I think this mostly happens when I try searching for a class rather than clicking through the tree.

    I also miss the tabbed browsing.

    Other than that I think this is a great improvement!

  7. #7
    Sencha Premium User
    Join Date
    Nov 2010
    Location
    Chicago
    Posts
    2,425

    Default

    Ext.AbstractComponent: renderSelectors config option doc.

    I think the documentation should mention that the 'renderTpl' is optional.

    The applyRenderSelectors() method will apply the renderSelectors whether or not renderTpl was provided.

    Perhaps I'm misreading the doc, but somehow it gives me the impression that renderSelectors should be used together with a 'renderTpl' template.

  8. #8
    Ext JS Premium Member
    Join Date
    Sep 2010
    Location
    Jyderup, Denmark
    Posts
    51

    Default

    When I select Vbox in the docs, I get the following error:

    Error: CouchDB Error: {"key":"Ext.layout.container.Vbox","error":"not_found"}


    When clicking the Sencha logo in the upper left corner of the docs, I get an 404:

    http://dev.sencha.com/deploy/ext-4.0...docs/api.html#

  9. #9
    Sencha Premium User
    Join Date
    Nov 2010
    Location
    Chicago
    Posts
    2,425

    Default Remove form layout in example

    http://dev.sencha.com/deploy/ext-4.0...Component.html

    The 'style' config example references the 'form' layout, which is no longer available in Rel. 4.

  10. #10
    Sencha Premium User
    Join Date
    Nov 2010
    Location
    Chicago
    Posts
    2,425

    Default

    http://dev.sencha.com/new/ext-js/4-0...od-nextSibling

    Search for "May also be refered to as prev()"

    Change prev --> next.

Page 1 of 17 12311 ... LastLast

Similar Threads

  1. Known Issues 0.92
    By Jamie Avins in forum Sencha Touch 1.x: Bugs
    Replies: 12
    Last Post: 28 Jul 2010, 8:27 AM
  2. IE 8 Issues
    By ggvicviper in forum Ext 3.x: Help & Discussion
    Replies: 0
    Last Post: 16 Nov 2009, 1:04 PM
  3. Issues with 3.0 vs. 2.2
    By Jose Gonzalez in forum Ext 3.x: Help & Discussion
    Replies: 2
    Last Post: 16 Oct 2009, 7:31 AM
  4. IE 8 Issues
    By aconran in forum Community Discussion
    Replies: 31
    Last Post: 30 Apr 2009, 5:45 AM

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •