1. #51
    Sencha User SimoAmi's Avatar
    Join Date
    Oct 2008
    Location
    New York
    Posts
    119
    Vote Rating
    3
    SimoAmi will become famous soon enough

      0  

    Default


    Great! Thank you.
    I'm still working on getting Ext3 examples to work. Will post back once done or if blocked.

  2. #52
    Ext JS Premium Member
    Join Date
    May 2011
    Posts
    1
    Vote Rating
    0
    aaronho is on a distinguished road

      0  

    Default


    I've quite a lot of js files in my folder, but I don't want to document them all at once, maybe per batch or selected ones. Is there a way where I can specify a text file of all the paths and feed it into jsduck?

  3. #53
    Ext JS Premium Member
    Join Date
    Nov 2011
    Location
    Falun, Sweden
    Posts
    9
    Vote Rating
    1
    tengl is on a distinguished road

      0  

    Default


    Awesome tool, for the first time ever it might be fun to document our code.

    One question, I tried to find examples on how models (that extends Ext.data.Model) should be documentet. I would like to display the field names without having to type them manually, preferably in the class description, but under the fields property would be good enough.
    Code:
    /**
    * Fields in the model. 
    */
    fields: [
       { name: 'description', type: 'string' },
       { name: 'value', type: 'string' },
       { name: 'isActive', type: 'bool' }
    ]
    


    Would output something like
    fields : Object
    The field in each menu item

    * description: string
    * value: string
    * isActive: bool

    Is that currently possible?


  4. #54
    Sencha User renku's Avatar
    Join Date
    Feb 2009
    Location
    Estonia
    Posts
    437
    Vote Rating
    17
    renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold

      0  

    Default


    @aaronho: One option is to create a JSON config file, where you can additionally list all kind of config options you want to pass to jsduck:

    Code:
    {
        "--verbose": true,
        "--output": "my/dir/",
        "--": [
            "src/file1.js",
            "src/file2.js",
            "src/file3.js"
        ]
    }
    And then run: jsduck --config myconfig.json

    Or you can just use xargs if you're on a UNIX system.

    @tengl: Currently the only way is to document them manually. See this comment.

    But now that several people have asked for it, I'm thinking of actually implementing support for this. IMHO the way to go is to auto-detect them as config options, but a separate doc-comment for each one would still be needed. I'd strive for something like this:

    Code:
    fields: [
       /**
        * Long description.
        */
       { name: 'description', type: 'string' },
       /**
        * Value of the item.
        */
       { name: 'value', type: 'string' },
       /**
        * True if active.
        */
       { name: 'isActive', type: 'bool' }
    ]

  5. #55
    Ext JS Premium Member
    Join Date
    Nov 2011
    Location
    Falun, Sweden
    Posts
    9
    Vote Rating
    1
    tengl is on a distinguished road

      0  

    Default


    Yes, you need comments on each one of course. It wouldn't be much overhead to add the @cfg tag but it would be nice if we didn't have to. Thanks for the reply.

  6. #56
    Sencha User
    Join Date
    Oct 2010
    Posts
    3
    Vote Rating
    0
    stoeffel is on a distinguished road

      0  

    Default not working

    not working


    Hi,
    I'm currently working on an application using ExtJs 4.0.7.
    It is a MVC application.
    The project has the following structur.
    app
    - model
    - view
    - controller
    app.js
    backend
    So i installed JSDuck (gem install jsduck) and all went well.
    Then I tried to generate the doc.
    jsduck /path/to/my/project/ --output=/path/to/the/output
    There was no error but a lot of warnings
    Warning: /Users/XY/dev/ProjectName/app/store/Zivilstand.js:15: Global method: exceptionCallback

    So i tried
    --warnings=-all --ignore-global

    The documentation looks well, but there are 90% of my classes missing in the documentation.

    Does somebody have a idea why it doesn't work?


    Thanks

  7. #57
    Sencha User renku's Avatar
    Join Date
    Feb 2009
    Location
    Estonia
    Posts
    437
    Vote Rating
    17
    renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold

      0  

    Default


    @stoeffel: The most likely cause is that you have only documented methods inside your classes but not the classes themselves. JSDuck only sees items that have a doc-comment, everything else gets ignored.

    Code:
    /**
     * You need a doc-comment here, otherwise the methods below
     * won't know which class they belong to.
     */
    Ext.define("MyClass", {
        /** Some method of MyClass */
        foo: function() {}
    });
    
    /**
     * This will also be treated as method of MyClass
     * unless you specify a different class for it with:
     * @member OtherClass
     */
    OtherClass.bar = function() {
    }

  8. #58
    Sencha User
    Join Date
    Oct 2010
    Posts
    3
    Vote Rating
    0
    stoeffel is on a distinguished road

      0  

    Default


    thanks:-)

  9. #59
    Sencha User ykey's Avatar
    Join Date
    Mar 2010
    Location
    USA
    Posts
    245
    Vote Rating
    27
    ykey has a spectacular aura about ykey has a spectacular aura about

      0  

    Default


    Although I can understand this behavior, is it configurable? Sometimes I just want to see all the classes in my application in the documentation without adding a class level comment.

  10. #60
    Sencha User renku's Avatar
    Join Date
    Feb 2009
    Location
    Estonia
    Posts
    437
    Vote Rating
    17
    renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold renku is a splendid one to behold

      0  

    Default


    It's not configurable, it's the limitation of the current implementation. JSDuck only looks at the doc-comments and a bit of code after it, if there's no doc-comment, there's nothing for it to begin it's look from. It's a very silly and mindless tool.

Turkiyenin en sevilen filmlerinin yer aldigi xnxx internet sitemiz olan ve porn sex tarzi bir site olan mobil porno izle sitemiz gercekten dillere destan bir durumda herkesin sevdigi bir site olarak tarihe gececege benziyor. Sitenin en belirgin ozelliklerinden birisi de Turkiyede gercekten kaliteli ve muntazam, duzenli porno izle siteleri olmamasidir. Bu yuzden iste. Ayrica en net goruntu kalitesine sahip adresinde yayinlanmaktadir. Mesela diğer sitelerimizden bahsedecek olursak, en iyi hd porno video arşivine sahip bir siteyiz. "The Best anal porn videos and slut anus, big asses movies set..."