[IPython-dev] Javascript comments

[Jonathan Frederic]

As a follow up of today's meeting, it looks like, if we don't mind the
comment appearing before the function, JSDoc allows for our own doc string
format (see simplest case): http://usejsdoc.org/about-getting-started.html
.  JSDoc claims to be "highly extensible" and has a markdown plugin
distributed with it.  Here's a good article comparing the 4 most popular JS
comment -> API doc tools:
http://blog.fusioncharts.com/2013/12/jsdoc-vs-yuidoc-vs-doxx-vs-docco-choosing-a-javascript-documentation-generator/

My preference is for JSDoc, but I'd like to hear what others think.  Also
the option to NOT use a comment -> doc parser still exists.  Provided we
can commit to keeping a separate API docs by hand.

Cheers,
Jon
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/ipython-dev/attachments/20141023/f1770570/attachment.html>