ipython/ipython — pull request #2571 by Carreau (2012-11-12 18:51:40+00:00)
Title: Start to document Javascript

Ok,
I looked at documenting javascript.

The 2 main school are :
* structured comment designed for JS
* inline comment with markdown/html

Or a mixed of the two.

I choose the first so that you could explicitely add things like `@deprecated`, `@class, `@static`.

Among those the difference in language is minimal. with most of the keywords in common and a few difference here and there like you to make crosslink.

lots of people like JsDoc and show it by forking it and adding incompatible option, so that v2 is almost 2 years old and has 4 implementation with different behavior. And the official one is deprecated.

v3 is "on it's way" with bugs like template not working. Exception about parsing command line after outputing half of the doc. Link in the doc not working.
But it is the one that require the less