1. #1
    Sencha User thejoker101's Avatar
    Join Date
    Mar 2007
    Posts
    349
    Vote Rating
    0
    thejoker101 is on a distinguished road

      0  

    Default No Docs Generated

    No Docs Generated


    When running JS Builder, we don't get any documentation generated. We aren't receiving any errors, either.

    We were able to generate documentation when we ran jsdoc from the command line, however.

    It seems to generate the documentation, as in it waits a while saying it is, but nothing is in the output directory for docs; the actual .js files are created though.

  2. #2
    Ext JS Premium Member
    Join Date
    Apr 2007
    Posts
    295
    Vote Rating
    6
    jheid is on a distinguished road

      0  

    Default


    Same thing here.

    As there is no changes.txt in the SVN this one should be fixed so I can see the differences between the versions in the docs.

    == Edit ==

    I used the newest JSDoc and it seems that it doesn't generates docs for ext at all. When trying to generate them manually I get many "Loading sources from..." messages, but no "Completed generating documentation" when trying with the provided "test.js". Perhaps the ext files aren't compatible with the new JSDoc version? Or I have missed something... Strange.

  3. #3
    Sencha User jack.slocum's Avatar
    Join Date
    Mar 2007
    Location
    Tampa, FL
    Posts
    6,955
    Vote Rating
    17
    jack.slocum will become famous soon enough jack.slocum will become famous soon enough

      0  

    Default


    JSDoc doesn't understand the Ext OO syntax. This is one of the reasons I wrote a parser.
    Jack Slocum
    Ext JS Founder
    Original author of Ext JS 1, 2 & 3.
    Twitter: @jackslocum
    jack@extjs.com

  4. #4
    Ext JS Premium Member
    Join Date
    Apr 2007
    Posts
    295
    Vote Rating
    6
    jheid is on a distinguished road

      0  

    Default


    Quote Originally Posted by jack.slocum View Post
    JSDoc doesn't understand the Ext OO syntax. This is one of the reasons I wrote a parser.

    Okay. Then... What about including the generated docs in the SVN? I know that's a little bit of work and it would be outdated often but otherwise there's no chance to see the actual docs in HTML, or is there another possibility?

  5. #5
    Ext User
    Join Date
    May 2007
    Posts
    25
    Vote Rating
    0
    cgoss is on a distinguished road

      0  

    Default index.html?

    index.html?


    Since the docs do not build properly, the docs folder is empty, thus no index.html file to view examples. Any ideas on how to see some examples of 2.0 in action?

  6. #6
    Sencha User trbs's Avatar
    Join Date
    Mar 2007
    Posts
    310
    Vote Rating
    0
    trbs is on a distinguished road

      0  

    Default


    FYI: i don't need the docs for viewing the examples. when you build Ext and have the ext files in the svn root directory, the examples work. You can view them by pointing your browser to an examples html file.

    somthing like:
    unix: file:///home/username/ext/examples/grid/array-grid.html
    windows: file://c:\ext\examples\grid\array-grid.html

    hope this helps.

  7. #7
    Ext User
    Join Date
    May 2007
    Posts
    25
    Vote Rating
    0
    cgoss is on a distinguished road

      0  

    Smile thanks

    thanks


    Thanks, didn't notice those at first. Docs would still be nice though...

  8. #8
    Ext User
    Join Date
    Jul 2007
    Posts
    3
    Vote Rating
    0
    MoNKi is on a distinguished road

      0  

    Default


    I'm also trying to use JSBuilder to generate the docs of a library I'm done with the Ext sintax and no output is created in the docs folder. No errors on JsBuilder is shown.

  9. #9
    Ext JS Premium Member stever's Avatar
    Join Date
    Mar 2007
    Posts
    1,407
    Vote Rating
    6
    stever will become famous soon enough stever will become famous soon enough

      0  

    Default


    Quote Originally Posted by MoNKi View Post
    I'm also trying to use JSBuilder to generate the docs of a library I'm done with the Ext sintax and no output is created in the docs folder. No errors on JsBuilder is shown.
    Same here. Jack, if you have your own processor instead of jsdoc.pl, can you put it up somewhere so we can build docs??? Please!

  10. #10
    Ext User
    Join Date
    Oct 2007
    Posts
    3
    Vote Rating
    0
    extjs33 is on a distinguished road

      0  

    Default


    When running JS Builder it is not necessary that we use documentation and also the chances of error will be reduces.

Similar Threads

  1. Docs for GotAPI.com
    By aconran in forum Community Discussion
    Replies: 6
    Last Post: 26 Apr 2007, 11:21 AM
  2. Offline docs
    By soso in forum Ext 1.x: Help & Discussion
    Replies: 1
    Last Post: 8 Mar 2007, 3:05 AM
  3. Docs offline?
    By corey.gilmore in forum Ext 1.x: Bugs
    Replies: 2
    Last Post: 21 Feb 2007, 3:41 PM
  4. Bug in Docs: Borderlayout
    By Wolfgang in forum Ext 1.x: Bugs
    Replies: 1
    Last Post: 12 Jan 2007, 12:12 PM
  5. Grid.destroy doesn't remove generated HTML
    By tryanDLS in forum Ext 1.x: Bugs
    Replies: 1
    Last Post: 5 Dec 2006, 5:43 AM

Thread Participants: 9