JS documentation generators

From	Stefan Weiss <krewecherl@gmail.com>
Newsgroups	comp.lang.javascript
Subject	JS documentation generators
Date	2013-09-19 02:31 +0200
Organization	albasani.net
Message-ID	<l1dgkc$46e$1@news.albasani.net> (permalink)

Show all headers | View raw

For those of you who write inline documentation blocks, what do you use
to generate a user-readable API documentation from your source files?

  [ ] JSDoc        <https://github.com/jsdoc3/jsdoc>
  [ ] YUIDoc       <http://yui.github.io/yuidoc/>
  [ ] Docco        <http://jashkenas.github.io/docco/>
  [ ] JSDuck       <https://github.com/senchalabs/jsduck>
  [ ] NaturalDocs  <http://www.naturaldocs.org/>
  [ ] DTK          <https://github.com/wkeese/api-viewer>
  [ ] something else: ____________
  [ ] something only available in my company
  [ ] built my own tool  (URL, if available: ____________)
  [ ] my IDE handles that  (which IDE? which plugin?)
  [ ] I just write the doc blocks, the rest is not my concern
  [ ] this is useless for JavaScript/ECMAScript/...
  [ ] I don't use anything like that, but want to check a box anyway
  [ ] what are inline documentation blocks?
  [ ] inline API documentation is WRONG
  [ ] comments are for the weak
  [ ] your logic is flawed

If I haven't covered all possible choices, just tell me what I missed.

- stefan

Back to comp.lang.javascript | Previous | Next — Next in thread | Find similar | Unroll thread

Thread

JS documentation generators Stefan Weiss <krewecherl@gmail.com> - 2013-09-19 02:31 +0200
  Re: JS documentation generators John Harris <niam@jghnorth.org.uk.invalid> - 2013-09-19 11:41 +0100
  Re: JS documentation generators Cezary Tomczyk <cezary.tomczyk@gmail.com> - 2013-09-19 15:08 +0200
    Re: JS documentation generators Thomas 'PointedEars' Lahn <PointedEars@web.de> - 2013-09-19 17:11 +0200
      Re: JS documentation generators Cezary Tomczyk <cezary.tomczyk@gmail.com> - 2013-09-19 20:35 +0200
        Re: JS documentation generators Thomas 'PointedEars' Lahn <PointedEars@web.de> - 2013-09-19 23:00 +0200
  Re: JS documentation generators Thomas 'PointedEars' Lahn <PointedEars@web.de> - 2013-09-19 17:55 +0200
  Re: JS documentation generators Christoph Michael Becker <cmbecker69@arcor.de> - 2013-09-19 18:03 +0200
  Re: JS documentation generators Aaron Sawyer <aaron.sawyer.NOSPAM@deltaware.com> - 2013-09-19 17:03 -0300
  Re: JS documentation generators Stefan Weiss <krewecherl@gmail.com> - 2013-09-30 02:24 +0200
  Re: JS documentation generators dhtml <dhtmlkitchen@gmail.com> - 2013-09-30 00:32 -0700
    Re: JS documentation generators Dr J R Stockton <reply1300@merlyn.demon.co.uk.invalid> - 2013-10-01 19:44 +0100
    Re: JS documentation generators Stefan Weiss <krewecherl@gmail.com> - 2013-10-02 05:33 +0200
      Re: JS documentation generators Thomas 'PointedEars' Lahn <PointedEars@web.de> - 2013-10-02 10:55 +0200
      Re: JS documentation generators John Harris <niam@jghnorth.org.uk.invalid> - 2013-10-02 14:53 +0100

csiph-web