JSDuck - the tool for documenting your Ext JS apps

[renku]

Sure. I've updated the install instructions.

[burnnat]

Excellent, followed the instructions and it works like a charm. Thanks, renku!

[renku]

JSDuck 3.11.2

Before getting to the final 4.0 release, I'm releasing an additional update to the 3.x line.

This should be of interest to those who started using Ext JS 3.4.1 which introduces the ability to use Ext.define(). Previously JSDuck assumed that code that uses Ext.define() must be Ext 4 code, and used this information to decide whether to append an Ext 4 specific additional parameter to all events. The new JSDuck adds --ext4-events option to override this auto-detection.

Additionally it contains bunch of fixes for the print pages, and support for new @chainable tag.

Full changelog.

[renku]

JSDuck 4.0.0 Final

So finally... JSDuck 4 is here. Lots of tweaking and polishing has gone into the final version. Let's recap what's JSDuck 4 bringing on the table:

- New JavaScript parser built on esprima.js which enables to do a lot more auto-detection than was previously possible. @cfg-s are automatically picked up from config: { ... } block, all private member are detected inside Ext.define().

- @enum tag for describing sets of values.

- Auto-generation of @since tags through performing comparison of docs for different versions.

- Ext4 overrides support. (Added since beta 2.)

- Improved command line help system providing much more information on all the various options, and a colored output of warnings and log messages. (Added since beta 2.)

Here's also a Changelog, but I've kept it short.

All the documentation has also been updated for 4.0. Installation instructions and everything else can be found from the JSDuck main page in Github.

Great thanks to everybody who's been trying out the betas. Hopefully the final version won't crash so easily. But if it does or there's something else unpleasant going on, feel free to post an issue.

Happy documenting

[droessner]

Thanks renku! Didn't have any issues running this new version.

[jsakalos]

Hmmm, cannot install it on Mountain Lion. Errors:

 sudo gem install jsduck
Building native extensions.  This could take a while...
ERROR:  Error installing jsduck:
        ERROR: Failed to build gem native extension.

/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby extconf.rb
*** extconf.rb failed ***
Could not create Makefile due to some reason, probably lack of
necessary libraries and/or headers.  Check the mkmf.log file for more
details.  You may need configuration options.

Provided configuration options:
        --with-opt-dir
        --without-opt-dir
        --with-opt-include
        --without-opt-include=${opt-dir}/include
        --with-opt-lib
        --without-opt-lib=${opt-dir}/lib
        --with-make-prog
        --without-make-prog
        --srcdir=.
        --curdir
        --ruby=/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby
extconf.rb:13: uninitialized constant Gem (NameError)
Checking for Python...

Gem files will remain installed in /Library/Ruby/Gems/1.8/gems/libv8-3.3.10.4 for inspection.
Results logged to /Library/Ruby/Gems/1.8/gems/libv8-3.3.10.4/ext/libv8/gem_make.out

[SimoAmi]

Hmmm, cannot install it on Mountain Lion. Errors:

Same problem here. Only I ran an update instead and using OSX Mountain Lion:

> sudo gem update jsduck
Password:
Updating installed gems
Updating jsduck
Fetching: libv8-3.3.10.4.gem (100%)
Building native extensions.  This could take a while...
ERROR:  Error installing jsduck:
	ERROR: Failed to build gem native extension.


        /System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby extconf.rb
*** extconf.rb failed ***
Could not create Makefile due to some reason, probably lack of
necessary libraries and/or headers.  Check the mkmf.log file for more
details.  You may need configuration options.


Provided configuration options:
	--with-opt-dir
	--without-opt-dir
	--with-opt-include
	--without-opt-include=${opt-dir}/include
	--with-opt-lib
	--without-opt-lib=${opt-dir}/lib
	--with-make-prog
	--without-make-prog
	--srcdir=.
	--curdir
	--ruby=/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/bin/ruby
extconf.rb:13: uninitialized constant Gem (NameError)
Checking for Python...


Gem files will remain installed in /Library/Ruby/Gems/1.8/gems/libv8-3.3.10.4 for inspection.
Results logged to /Library/Ruby/Gems/1.8/gems/libv8-3.3.10.4/ext/libv8/gem_make.out
Nothing to update

[renku]

I think the problem might be that certain header files don't ship with OS X and aren't also installed by x-code.

At least according to this: http://stackoverflow.com/a/9461582

I personally have GCC installed instead of x-code, so this might be the main difference here. I'll have to investigate further...

[shmeltex]

JSDuck 4.0.0 works fine on Mountain Lion.
My setup:
X-Code + Command Line Tools (no GCC)
RVM + Ruby 1.9.3-p194

[renku]

@jsakalos Did you have JSDuck 3.x installed previously? If not, you need to make sure you have x-code or some other package installed that provides you with C compiler and other related tools.

@SimoAmi & @jsakalos In both cases, to see what exactly went wrong, post what was written to /Library/Ruby/Gems/1.8/gems/libv8-3.3.10.4/ext/libv8/gem_make.out

The real problem here is with therubyracer gem, so check out this thread: http://stackoverflow.com/questions/1...-mac-os-x-lion

Also, the problem might be with Ruby 1.8. JSDuck should work with both 1.8 and 1.9, but you both got 1.8 and the install failed while shmeltex got 1.9 and installed without problems.