JSDuck - the tool for documenting your Ext JS apps

[renku]

JSDuck 3.10 now available

Two major things have been added:

--tests option which creates a page for testing all the inline examples. The inline examples can now also be easily extracted using --export=examples option. Thanks to Dave Thompson for contributing initial implementation of all this.

--no-source option which disables the output of source code.

Plus bunch of smaller fixes.

Full changelog

[xuebi1109]

It can only generate extjs and sencha touch framework document？

/**
**some
**/
function Cls(){}
Cls.prototype={
   /**
   *@a Array
   *@return Object
   **/
   method:function(a){}
};

This can also use?
If can!
Can you give me an example!
very thanks;

[xuebi1109]

JSDuck 3.10 now available

Two major things have been added:

--tests option which creates a page for testing all the inline examples. The inline examples can now also be easily extracted using --export=examples option. Thanks to Dave Thompson for contributing initial implementation of all this.

--no-source option which disables the output of source code.

Plus bunch of smaller fixes.

Full changelog

It can only generate extjs and sencha touch framework document？

/****some**/function Cls(){}Cls.prototype={ /** *@a Array *@return Object **/ method:function(a){}};This can also use?
If can!
Can you give me an example!
very thanks;

[zombeerose]

Any suggestions regarding this error:
Error while parsing C:/....js: invalid byte sequence in UTF-8

One example of a file that will kill the process contains this...
/**
* @author Ing. Jozef Sakáloš
* @copyright (c) 2008, Ing. Jozef Sakáloš
*/

[renku]

You can use the --encoding option to specify a different input encoding than UTF-8.

[zombeerose]

Thanks. I switched encoding to "ISO-8859-1" and all is well.

[SamuraiJack1]

Is there an option to disable the automatic creation of the parameters for functions?

Lets say I have this method:

    /**
     * Returns the task associated with this assignment.
     * 
     * @return {Gnt.model.Task} task
     */
    getTask: function (taskStore) {
    },

and the "taskStore" argument is private. I would prefer it not appearing in the resulting documentation, to not confuse user with private API.

Now JSDuck seems to generates a stub for this parameter - its not so much of use w/o explanations anyway.

Same for default values. Sometimes I explicitly specify what is the default value of some property and JSDuck repeats it.

[renku]

To get rid of auto-detection for method parameters you can do something like this:

    /**
     * Returns the task associated with this assignment.
     * 
     * @return {Gnt.model.Task} task
     * @method getTask
     */
    /** @ignore */
    getTask: function (taskStore) {
    },

For config options you can use the same approach or you could explicitly specify the default value as undefined:

    /**
     * @cfg {String} [title=undefined]
     * Defaults to something not very interesting.
     */
    title: "Noname",

Hopefully both of these cases are an exception rather than a rule in your code, so you can mostly still benefit from auto-detection but disable it on the specific cases it gets in your way.

[SamuraiJack1]

/** @ignore */ did it. Thanks a lot for your help (and great tool)!

[renku]

JSDuck 3.11 now available

The main thing is much improved support for documenting SCSS variables and mixins. Most importantly the functionality is now documented. I'm still considering the whole thing somewhat experimental, but given that Sencha Touch documentation has been using the feature for quite a while now, it's unlikely that future versions will introduce actual breaking changes to this.

Another main thing added is support for @throws tag.

Full changelog