1. #1
    Sencha Premium Member
    Join Date
    May 2012
    Posts
    52
    Vote Rating
    11
    celticboyone will become famous soon enough

      0  

    Default Architect and JSDuck

    Architect and JSDuck


    Is there any update on this?

    Thank you

  2. #2
    Sencha Premium Member
    Join Date
    May 2012
    Posts
    52
    Vote Rating
    11
    celticboyone will become famous soon enough

      0  

    Default


    Hmmmm... for those who may not know, JSduck is a really great documentation tool that automatically creates documentation for your application. In fact, with one command it will create an entire help website for your application exactly the same at the Sencha docs do. It will automatically extract class definitions, function names, parameters, and so on. You can embed code and even the iPhone simulator. You can have tabs across the top just like Sencha docs. Yes, all with one command, it is super easy to use. You can compliment it with comments of your own of course (which you should be doing) , but make sure they are like this (I hope this formats correctly):

    Code:
    /**
    * Your comment here
    */
    But Houston, we have a problem, it won't work with Architect. Ironically it will work with the free versions of Sencha. If you search the forums you will find positive mention about it and Architect but unfortunately 2.1 does not appear to allow it. It sounds rather simple to implement - the ability to insert a comment before a class definition or function/event handler, it's doesn't have to actually do anything - just comments - Sencha already inserts licensing information there.

    Hopefully we will hear something soon about this great tool.

  3. #3
    Sencha - Architect Dev Team aconran's Avatar
    Join Date
    Mar 2007
    Posts
    9,359
    Vote Rating
    128
    aconran is a splendid one to behold aconran is a splendid one to behold aconran is a splendid one to behold aconran is a splendid one to behold aconran is a splendid one to behold aconran is a splendid one to behold aconran is a splendid one to behold

      0  
    Aaron Conran
    @aconran
    Sencha Architect Development Team

  4. #4
    Sencha Premium Member
    Join Date
    May 2012
    Posts
    52
    Vote Rating
    11
    celticboyone will become famous soon enough

      0  

    Default


    Awesome, this is really great news. We would all look like geniuses if we had documentation from JSDuck. Imagine your boss asking "How is the project coming along..." and you were to show him the output from JSDuck! That would be impressive

  5. #5
    Sencha User
    Join Date
    May 2011
    Location
    Melbourne, Australia
    Posts
    89
    Vote Rating
    7
    Greg Arnott is on a distinguished road

      0  

    Default


    Quote Originally Posted by aconran View Post
    We're aware of the need ...

    Other forum references of people requesting the same thing (you're not alone).
    After 7 months of development, starting 3 months after the last update to this post. A project with over 100 files, each with their own assortment of methods and cross-references.... Literally hundreds of manually added entries... (I AM SO ALONE)

  6. #6
    Sencha - Architect Dev Team aconran's Avatar
    Join Date
    Mar 2007
    Posts
    9,359
    Vote Rating
    128
    aconran is a splendid one to behold aconran is a splendid one to behold aconran is a splendid one to behold aconran is a splendid one to behold aconran is a splendid one to behold aconran is a splendid one to behold aconran is a splendid one to behold

      0  

    Default


    It's one of those ones I'd really like to see in too. We just haven't gotten to it yet. At this point we are really trying to nail down the stability in Architect 3.0.
    Aaron Conran
    @aconran
    Sencha Architect Development Team

Thread Participants: 2