JSDuck - the tool for documenting your Ext JS apps

I am using 4.5.1.

You're right, the class jquery.q/extends jquery stuff was a hack to get q to appear. Now that I've added the dummy @class jQuery, that works correctly with just a member tag

Code:

---

/**
 * @class jQuery
 * jQuery library is documented here <http://jqapi.com> <br />
*/
...
/**
 * @member jQuery
 * @chainable
 * jQuery selector cachin
 * @param {String} selector any jQuery selector string
 * @param {Boolean} [clear=false] force the cache for this selector to be cleared and re-read from DOM
 * @return {jQuery}
*/

---

As for the Global vs global thing - I just used the uppercase format in my tags b/c it looked cleaner, in the output - it's not a real class.

JSDuck 4.6 released

This implements a long-requested feature of automatically closing down unclosed HTML tags inside documentation. Previously a single unclosed <div> could mess up the layout of the docs in severe ways while being hard to track down. Now all tags get automatically closed and a warning message gets printed, so you'll know where the problems are.

In relation to this there's a new --ignore-html=TAG option to allow some tags to remain open - that's currently mainly geared towards ExtJS and Touch codebases that contain <debug> and <locale> tags for post-processing purposes.

Several other smaller fixes have gone in too. See the changelog for details.

JSDuck 5.0 beta released

Today I'm happy to announce JSDuck 5.0 beta release, which brings a new custom tags system which is way more flexible than the old system was.

The new tags system is not backwards compatible. Any existing custom tags will need to be converted to the new format. The --meta-tags option has been replaced with a --tags option - hinting that the new system is for more than just some meta-data, and indeed, all the builtin tags of JSDuck are now also implemented with this new system.

Read the guide for all the details.

All of this is still in flux, all the features aren't in yet and the API can still change in substantial ways. And that's why now is the perfect opportunity to give feedback. Can you do what you want with the new API? Was it easy or hard? Did you run into bugs? Other ideas and suggestions? All feedback will be most appreciated.

Besides the tags system, the 5.0 should be very backwards compatible and quite stable in its running. Give it a try!

To install the beta, run:

Code:

---

$ gem install jsduck --pre

---

Also in news: JSDuck 4.6.2

An incremental patch release with some bugfixes.

See the changelog for details.

Note: At the moment the Windows binaries are missing from both releases. Hoping to get them out tomorrow.

Hi renku,
Thanks for your amazing works in JSDuck, a truly great piece of software.
I've a question regarding the new JSDuck 5:
We currently use the JSON files generated by JSDuck on ExtJS 4.2 sources to automatically generate custom code. Does the new tag system change the generated JSON for ExtJS 4.2 (tag names or structure) ?

Quote:

---

Originally Posted by dwahli

Does the new tag system change the generated JSON for ExtJS 4.2 (tag names or structure) ?

---

Yes. It has changed slightly in this first beta and I'm planning to change it even more. The concrete names of the various fields should stay exactly the same, but there are some structural changes.

For start the "meta" field is now gone, as there is no meta-tags system any more. Anything that appeared inside "meta" (like "deprecated" and "protected") is now inside the main hash of a member or class. For example:

In 4.x:

Code:

---

{"tagname": "method", "meta": {"protected": true}}

---

In 5.x:

Code:

---

{"tagname": "method", "protected": true}

---

I'm also planning to change the overall structure of how class members are listed. Currently they're inside this complex nested structure:

Code:

---

{
  "tagname": "class",
  "members": {"method": [...], "event": [...]},
  "statics": {"method": [...], "event": [...]}
}

---

My plan is to just have a simple array listing all the members:

Code:

---

{
  "tagname": "class",
  "members": [...]
}

---

This should simplify parsing the exported data on most cases.

Thanks renku for your comprehensive answer.
Look good to me, waiting Windows binary to give it a try.

Windows binaries for both 4.6.2 and 5.0 beta are now available:

https://sourceforge.net/projects/jsduck/files/

This sure has come a long way. Nice work Renku. =D>

JSDuck 4.7 released

Another incremental update on JSDuck 4.x line.

Configuration is now automatically read from jsduck.json file from current directory. So you can just place this file into your project root dir and ask your fellow developers to simply run the jsduck command with no other parameters.

The footer of docs now by default contains the date and time when the docs were generated. Accordingly the --footer option now recognizes {DATE} placeholder.

Some additional work went in to decouple JSDuck from RubyGems system, so it can be packaged differently e.g. into a Debian package.

And I've already released JSDuck 4.7.1 to patch problems with IE10.

See the changelog for details.

Are Functions support as config options? Had some issues getting those to show up...