JSDuck - the tool for documenting your Ext JS apps

[droessner]

renku, I'm not able to download the Windows version of 3.11.0. github always shows a "File was not found." error. Never had this issue when downloading previous versions.

Thanks,
Danny

[renku]

Indeed. Unfortunately can't fix this right now as I don't have a Windows machine at hand. It'll have to wait a week or two while I'm away. Sorry.

[droessner]

Thanks renku. The previous version is working fine for me right now, just wanted to give you a heads up.

[renku]

Releasing JSDuck 4 beta

Version 4 brings some large changes to JSDuck internals - a new JavaScript parser, or rather a real JavaScript parser (the previous versions relied more on heuristics and didn't really parse the full syntax tree). Using the awesome esprima.js parser enables a lot more auto-detection than was previously possible. For example you no more need to use @cfg tag when you're listing your config options inside config: { ... } block.

While the parser is new, it's backwards compatible - so what worked in 3.x should also be working in 4.x. Mostly it should just detect more stuff - lot's of private members, etc. But I'm sure there are regressions that my unit tests haven't caught. That's what the beta is for. There are many more things that can be implemented on top of the new parser, but currently my main interest is how it compares with 3.x.

There's currently one major downside that I'm aware of: performance under Windows has degraded considerably. I'll be looking at some alternative approaches to improve on this area.

Installation instructions and more...

As always, any feedback will be most appreciated.

[Mosely]

I'm having some trouble getting my custom tags working. This is the error:

C:/Users/mtooke/AppData/Local/Temp/ocr62D3.tmp/lib/ruby/site_ruby/1.9.1/rubygems/custom_require.rb:36:in `require': C:/Users/mtooke/AppData/Local/Temp/ocr62D3.tmp/lib/ruby/gems/1.9.1/gems/jsduck-3.11.
0/lib/jsduck/tag/feature.rb:5: class/module name must be CONSTANT (SyntaxError)
  class feature < JsDuck::MetaTag
                 ^
        from C:/Users/mtooke/AppData/Local/Temp/ocr62D3.tmp/lib/ruby/site_ruby/1.9.1/rubygems/custom_require.rb:36:in `require'
        from C:/Users/mtooke/AppData/Local/Temp/ocr62D3.tmp/lib/ruby/gems/1.9.1/gems/jsduck-3.11.0/lib/jsduck/meta_tag_loader.rb:37:in `load_file'
        from C:/Users/mtooke/AppData/Local/Temp/ocr62D3.tmp/lib/ruby/gems/1.9.1/gems/jsduck-3.11.0/lib/jsduck/meta_tag_loader.rb:27:in `block in load'
        from C:/Users/mtooke/AppData/Local/Temp/ocr62D3.tmp/lib/ruby/gems/1.9.1/gems/jsduck-3.11.0/lib/jsduck/meta_tag_loader.rb:27:in `each'
        from C:/Users/mtooke/AppData/Local/Temp/ocr62D3.tmp/lib/ruby/gems/1.9.1/gems/jsduck-3.11.0/lib/jsduck/meta_tag_loader.rb:27:in `load'
        from C:/Users/mtooke/AppData/Local/Temp/ocr62D3.tmp/lib/ruby/gems/1.9.1/gems/jsduck-3.11.0/lib/jsduck/meta_tag_loader.rb:22:in `load'
        from C:/Users/mtooke/AppData/Local/Temp/ocr62D3.tmp/lib/ruby/gems/1.9.1/gems/jsduck-3.11.0/lib/jsduck/meta_tag_registry.rb:38:in `block in load'
        from C:/Users/mtooke/AppData/Local/Temp/ocr62D3.tmp/lib/ruby/gems/1.9.1/gems/jsduck-3.11.0/lib/jsduck/meta_tag_registry.rb:38:in `each'
        from C:/Users/mtooke/AppData/Local/Temp/ocr62D3.tmp/lib/ruby/gems/1.9.1/gems/jsduck-3.11.0/lib/jsduck/meta_tag_registry.rb:38:in `load'
        from C:/Users/mtooke/AppData/Local/Temp/ocr62D3.tmp/lib/ruby/gems/1.9.1/gems/jsduck-3.11.0/lib/jsduck/options.rb:134:in `parse!'
        from C:/Users/mtooke/AppData/Local/Temp/ocr62D3.tmp/lib/ruby/gems/1.9.1/gems/jsduck-3.11.0/bin/jsduck:25:in `<main>'

This is my class:

require "jsduck/meta_tag"

module JsDuck::Tag
  # Implementation of @featureID tag
  class feature < JsDuck::MetaTag
    def initialize
      @name = "featureID"
      @key = :featureID
      @signature = {:long => "featureID", :short => "TMP"}
      @boolean = true
    end

    def to_html(contents)
      <<-EOHTML
      <div class='signature-box featureID'>
      <p>This is a <a href="#!/guide/components">featureID method</a>.
         a hook into the functionality of this class.
         Feel free to override it in child classes.</p>
      </div>
      EOHTML
    end
  end
end

I can pass it in on the command line without problems, and it works when I used the provided sample LicenseTag as the class name, but when I change the class name to something else, I get this error. What am I doing wrong?

Thanks in advance. Awesome tool btw!

[renku]

Class names and other constants must begin with an uppercase letter in Ruby. Just use "Feature" instead of "feature".

[Mosely]

Ahh - thanks!

[renku]

@John220: Your command of the English language makes it hard to decipher what you're trying to say. You can use --images option multiple times to specify several paths (if that's what you were asking for).

[renku]

Alternative Windows version of JSDuck 4 beta

Given the downsides of the current exe, I'm experimenting with bringing JSDuck 4 to Windows using JRuby.

It should work better out-of-the-box, without requirering an existance of nodejs. Though the speed is still about the same as using the exe. So not much progress on that side, but I'm hoping to improve that using native threads available in JRuby.

See the installation instructions in wiki.

And any feedback is still most appreciated - so far there's been zero of it - if you're depending on jsduck, you should really give a test run to the beta, it should fairly solid actually.

[Mosely]

Apologies if this has been asked before, but can you tell me if markdown tables are supported in JSDuck? I can't seem to make anything work.If not, is there a list of supported and unsupported markdown syntax available?

I'm trying to write an XSLT transform that converts our XHTML to markdown.

Thanks in advance!