Results 1 to 3 of 3
  1. #1
    Power Member
    Join Date
    Nov 2012
    Posts
    182

    Use of jsdoc3 for client documentation

    Bit of a cheek this, but is there any chance of you guys sharing the template you have created for jsdoc3?

    I am especially interested in the method summary and index page and the jsdoc3 developer says he is not likely to include these features any time soon.

  2. #2
    Power Member
    Join Date
    Jul 2006
    Location
    Cesano Maderno, Italy
    Posts
    784
    well I guess I can share it but it comes with some "warnings"

    there are some little changes in the core itself (files changed: jsdoc.js, rhino_modules/jsdoc/util/templateHelper.js )
    have to be used with rhino or changes made to rhino's templateHelper.js have to be ported to the node version
    the jsdoc library was imported on the 16th june 2012 (you need this info to merge our changes in the latest version of the lib, or if you simply want to make a diff )

    the template is based on the default one
    it may contain some "lightstreamer" strings hard-coded in the template
    the template may not support structure we weren't interested in

    obviously it comes with no support


    HTH
    Attached Files Attached Files

  3. #3
    Power Member
    Join Date
    Nov 2012
    Posts
    182
    Thankyou very much. I will have a play with it.

 

 

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  
All times are GMT +1. The time now is 04:05 AM.