Page 12 of 29 FirstFirst ... 2101112131422 ... LastLast
Results 111 to 120 of 288

Thread: JSDuck - the tool for documenting your Ext JS apps

  1. #111
    Sencha User renku's Avatar
    Join Date
    Feb 2009
    Location
    Estonia
    Posts
    437
    Vote Rating
    17
      0  

    Default

    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

  2. #112
    Sencha User
    Join Date
    Mar 2010
    Location
    china
    Posts
    8
    Vote Rating
    0
      0  

    Default

    It can only generate extjs and sencha touch framework document?
    Code:
    /**
    **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;

  3. #113
    Sencha User
    Join Date
    Mar 2010
    Location
    china
    Posts
    8
    Vote Rating
    0
      0  

    Default

    Quote Originally Posted by renku View Post
    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;

  4. #114
    Ext JS Premium Member
    Join Date
    Mar 2008
    Location
    Phoenix, AZ
    Posts
    646
    Vote Rating
    12
      0  

    Default

    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 Saklo
    * @copyright (c) 2008, Ing. Jozef Saklo
    */

  5. #115
    Sencha User renku's Avatar
    Join Date
    Feb 2009
    Location
    Estonia
    Posts
    437
    Vote Rating
    17
      1  

    Default

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

  6. #116
    Ext JS Premium Member
    Join Date
    Mar 2008
    Location
    Phoenix, AZ
    Posts
    646
    Vote Rating
    12
      0  

    Default

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

  7. #117
    Sencha - Community Support Team SamuraiJack1's Avatar
    Join Date
    May 2008
    Posts
    571
    Vote Rating
    6
      0  

    Default

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

    Lets say I have this method:

    Code:
        /**
         * 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.

  8. #118
    Sencha User renku's Avatar
    Join Date
    Feb 2009
    Location
    Estonia
    Posts
    437
    Vote Rating
    17
      0  

    Default

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

    Code:
        /**
         * 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:

    Code:
        /**
         * @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.

  9. #119
    Sencha - Community Support Team SamuraiJack1's Avatar
    Join Date
    May 2008
    Posts
    571
    Vote Rating
    6
      0  

    Default

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

  10. #120
    Sencha User renku's Avatar
    Join Date
    Feb 2009
    Location
    Estonia
    Posts
    437
    Vote Rating
    17
      1  

    Default

    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

Page 12 of 29 FirstFirst ... 2101112131422 ... LastLast

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •