-
4 Jan 2013 1:37 PM #1
Architect and JSDuck
Architect and JSDuck
Is there any update on this?
Thank you
-
7 Jan 2013 12:42 PM #2
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):
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.Code:/** * Your comment here */
Hopefully we will hear something soon about this great tool.
-
7 Jan 2013 1:41 PM #3
We're aware of the need and are tracking to get this in some time after 2.2.
Other forum references of people requesting the same thing (you're not alone).
http://www.sencha.com/forum/showthre...-JSDoc-support
http://www.sencha.com/forum/showthre...havior-objects
http://www.sencha.com/forum/showthre...-documentation
http://www.sencha.com/forum/showthre...ods-properties...
http://www.sencha.com/forum/showthre...s-to-functions
http://www.sencha.com/forum/showthre...o-add-Comments
http://www.sencha.com/forum/showthre...ect-and-JSDuckAaron Conran
@aconran
Sencha Architect Development Team
-
7 Jan 2013 1:59 PM #4
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


Reply With Quote