1. #1
    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

      3  

    Default JSDuck - the tool for documenting your Ext JS apps

    JSDuck - the tool for documenting your Ext JS apps


    Today I'm happy to announce the release of JSDuck 3.0.

    The project has grown quite tremendously since the initial 0.1 release almost a year ago. No more is it an alternative documentation generator, but an official one. Therefore I'm closing the old forum thread which has lots of outdated information and start a new fresh one.

    Check out JSDuck at Github.

    Although a lot has changed, the main features of JSDuck have remained the same:

    * Support for Markdown, so you can write human-readable comments.

    * Strong adherence to the DRY principle, so you don't have to repeat in comments what you already have said in code.

    Over time JSDuck has been extended outside the realm of basic API documentation, allowing the creation of guides, examples and other things you see in the official Ext JS 4 documentation.

    But for most users, these aren't as useful, so for this 3.0 release I'd like to highlight the latest and greatest API documentation related features:

    * Inline examples allow you embed live demos of your components (no more limited to Ext JS 4 components) inside the documentation. No more will you need to create screenshots to show how your component looks like. Simple add an @example tag, and there you have it.

    * Custom tags allow you to add support for metadata tags that JSDuck doesn't support natively, like @license, @date, @version.

    Read the Advanced Usage Guide for details.

    Like always, JSDuck is just a simple gem install away:

    Code:
    $ [sudo] gem install jsduck
    For Windows users, there is a downloadable binary version.

    For latest changes, see the changelog.
    Last edited by renku; 24 Oct 2011 at 1:54 AM. Reason: Add windows download link

  2. #2
    Sencha - Community Support Team SamuraiJack1's Avatar
    Join Date
    May 2008
    Posts
    550
    Vote Rating
    3
    SamuraiJack1 will become famous soon enough

      0  

    Default


    When installing JSDuck on Ubuntu I'm getting this:

    Code:
    nickolay@nickolay-note:~$ sudo gem install jsduck
    Building native extensions.  This could take a while...
    Building native extensions.  This could take a while...
    ERROR:  Error installing jsduck:
            jsduck requires RubyGems version >= 1.3.7
    nickolay@nickolay-note:~$ gem -v
    1.3.5
    nickolay@nickolay-note:~$
    Any hints?

  3. #3
    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


    Strange that nobody has asked for this before. I downgraded the required RubyGems to 1.3.5 and released JSDuck 3.0.1.

    The only reason I required 1.3.7 was me having this version when I released JSDuck 0.1.

  4. #4
    Sencha Premium Member dawesi's Avatar
    Join Date
    Mar 2007
    Location
    Melbourne, Australia (aka GMT+10)
    Posts
    1,083
    Vote Rating
    44
    dawesi has a spectacular aura about dawesi has a spectacular aura about

      0  

    Default


    woo hoo! can't wait for the final win version!
    Teahouse Training Company
    Official Certified Sencha Trainer

    Australia / New Zealand / Singapore / Hong Kong & APAC



    SenchaWorld.com - Sencha webinars, videos, etc
    SenchaForge.org - (coming soon)
    TeahouseHQ.com - Sencha ecosystem training portal

    Code Validation : JSLint | JSONLint | JSONPLint

  5. #5
    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


    The Windows binary is now also available.

  6. #6
    Sencha User
    Join Date
    May 2011
    Location
    Northern California
    Posts
    255
    Vote Rating
    17
    BillHubbard has a spectacular aura about BillHubbard has a spectacular aura about BillHubbard has a spectacular aura about

      0  

    Default


    When I get an image not found warning, there is no indication as to where the image is referenced (i.e. no file or line number).

    I am having difficulty with the --images option. How do I specify multiple image folders? I've tried doing
    --images=path/to/one/folder/,path/to/another/folder
    but it doesn't work. What is the proper delimiter to use?

    Also, can you provide an example of the --img option - I have been unable to get it to work.

  7. #7
    Sencha User
    Join Date
    May 2011
    Location
    Northern California
    Posts
    255
    Vote Rating
    17
    BillHubbard has a spectacular aura about BillHubbard has a spectacular aura about BillHubbard has a spectacular aura about

      0  

    Default


    I'm having a small issue with --images options. Here's my setup...

    I have the jsduck executable in a folder (say, c:\jsduck).
    I have a folder under that called content (c:\jsduck\content).
    In the content folder, I have the welcome.html and json files (for categories, guides and videos), plus another folder called images where I want to put some loose images.
    To build, I specify --images=c:\jsduck\content\

    In doc-comments, to access a loose image from my images folder, I can specify:
    {@img images/someimage.png Sample Image}

    But in markdown for a guide, I have to specify:
    ![Sample image](images/images/someimage.png)

    It looks like in the doc output, an images folder is getting created to contain all the images, so my loose images get copied into there under another images folder. But it is curious that it resolves correctly in the doc-comments, but not in the markdown.

    References such as the following resolve correctly:
    ![Another Image](guides/myguide/guideimage.png)

  8. #8
    Sencha User
    Join Date
    May 2011
    Location
    Northern California
    Posts
    255
    Vote Rating
    17
    BillHubbard has a spectacular aura about BillHubbard has a spectacular aura about BillHubbard has a spectacular aura about

      0  

    Default


    I don't suppose there is a way to turn off specific warnings - like this one?
    "Optional param can't be followed by regular param {name}"

    Or at least re-word it so that it is stated as a warning and not a limitation.
    "Optional param is followed by an expected param {name}"

  9. #9
    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

      -1  

    Default


    To provide multiple image input directories you should simply use the --images option multiple times:

    Code:
    jsduck --images /dir/1 --images /dir/2
    This option currently only affects {@img} tags inside doc-comments.

    I don't really understand why would you specify --images=c:\jsduck\content\ if it's really the c:\jsduck\content\images that contains the images. But anyway...

    To link images from guide contained in the same directory as the guide itself, the simple {@img} tags should work: {@img image_name.png}

    But I guess the main problem is that you try to share images between comments and guides. That's a very reasonable wish, but unfortunately JSDuck has no support for this at all... besides the ![Sample image](some/path.png) syntax which is Markdown version of simply using the <img> tag, allowing you to link any image on the internet whatsoever.

    I'll have to come up with some better approach to support that kind of sharing.

    As for the warning messages... these also need to be improved.

    * * *

    A good example of the --img option is it's default value:

    Code:
    jsduck --img '<p><img src="%u" alt="%a"></p>'
    But there shouldn't be much need to change it.

  10. #10
    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


    I do have a plan to allow more granular control over which warnings get hidden/shown. But this particular warning should indeed be reworded, as it's more of an ExtJS convention than limitation in JavaScript.

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..." hd porno faketaxi