JSDuck - the tool for documenting your Ext JS apps

[renku]

Today I'm happy to announce the release of JSDuck 3.0.

The project has grown quite tremendously since the initial 0.1 release almost a year ago. No more is it an alternative documentation generator, but an official one. Therefore I'm closing the old forum thread which has lots of outdated information and start a new fresh one.

Check out JSDuck at Github.

Although a lot has changed, the main features of JSDuck have remained the same:

* Support for Markdown, so you can write human-readable comments.

* Strong adherence to the DRY principle, so you don't have to repeat in comments what you already have said in code.

Over time JSDuck has been extended outside the realm of basic API documentation, allowing the creation of guides, examples and other things you see in the official Ext JS 4 documentation.

But for most users, these aren't as useful, so for this 3.0 release I'd like to highlight the latest and greatest API documentation related features:

* Inline examples allow you embed live demos of your components (no more limited to Ext JS 4 components) inside the documentation. No more will you need to create screenshots to show how your component looks like. Simple add an @example tag, and there you have it.

* Custom tags allow you to add support for metadata tags that JSDuck doesn't support natively, like @license, @date, @version.

Read the Advanced Usage Guide for details.

Like always, JSDuck is just a simple gem install away:

$ [sudo] gem install jsduck

For Windows users, there is a downloadable binary version.

For latest changes, see the changelog.

[SamuraiJack1]

When installing JSDuck on Ubuntu I'm getting this:

nickolay@nickolay-note:~$ sudo gem install jsduck
Building native extensions.  This could take a while...
Building native extensions.  This could take a while...
ERROR:  Error installing jsduck:
        jsduck requires RubyGems version >= 1.3.7
nickolay@nickolay-note:~$ gem -v
1.3.5
nickolay@nickolay-note:~$

Any hints?

[renku]

Strange that nobody has asked for this before. I downgraded the required RubyGems to 1.3.5 and released JSDuck 3.0.1.

The only reason I required 1.3.7 was me having this version when I released JSDuck 0.1.

[dawesi]

woo hoo! can't wait for the final win version!

[renku]

The Windows binary is now also available.

[BillHubbard]

When I get an image not found warning, there is no indication as to where the image is referenced (i.e. no file or line number).

I am having difficulty with the --images option. How do I specify multiple image folders? I've tried doing
--images=path/to/one/folder/,path/to/another/folder
but it doesn't work. What is the proper delimiter to use?

Also, can you provide an example of the --img option - I have been unable to get it to work.

[SamuraiJack1]

Strange that nobody has asked for this before. I downgraded the required RubyGems to 1.3.5 and released JSDuck 3.0.1.

The only reason I required 1.3.7 was me having this version when I released JSDuck 0.1.

Works now, thanks a lot!

[renku]

@BillHubbard: Could you provide a test case that causes this crash. The line that you removed alone in a file doesn't seem to cause any problems, but I'd like to find out what does.

[BillHubbard]

@BillHubbard: Could you provide a test case that causes this crash. The line that you removed alone in a file doesn't seem to cause any problems, but I'd like to find out what does.

Unfortunately, I am now unable to recreate this problem. I made a lot of changes in doc-comments and guides since I posted the issue last week, so maybe there was some unusual combination of things that created the problem. The offending file was still open in my editor this morning, so I did undo all the way back to where the issue happened, but now the issue is no longer showing up, so perhaps it was a condition in an adjacent file in the process that got corrected with other changes.

I'll let you know if I encounter it again.

[BillHubbard]

When the help page opens, the Ext branch is expanded by default. Is there a way to make it closed by default, or to specify a different branch to be open?