See also - documentationjs/documentation GitHub Wiki
documentation
is a documentation generator for API documentation.
It uses a code scanner and supports structured documentation, so it follows
in the tradition of tools like JavaDoc, Natural Docs, and JSDoc. There are
other camps of documentation generation, like literate documentation, which
is less structured and more focused on understanding internal code structure.
Full-Fledged JSDoc
- https://github.com/yui/yuidoc
- https://github.com/senchalabs/jsduck
- https://github.com/esdoc/esdoc
- https://pypi.python.org/pypi/sphinx-js/
- https://github.com/dtao/autodoc
Literate Style
- http://nevir.github.io/groc/ (unmaintained)
- http://jashkenas.github.io/docco/
Testing for the presence of documentation
- Inch CI measures the percentage of source code that is described by JSDoc comments
Testing documentation itself
- jsdoctest tests code examples in
@example
tags.
JavaScript Syntax Extensions
Alternative Syntaxes
- ngdoc for Angular https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation - parsed by dgeni
- Google Clojure Compiler extensions https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler
- https://github.com/marijnh/getdocs
- https://github.com/IvanSanchez/Leafdoc
- https://github.com/nodeca/ndoc
Standalone JSDoc Parsers
JSDoc to Markdown
- https://github.com/75lb/dmd
- https://github.com/jdalton/docdown
- https://github.com/tmcw/doxme
- https://github.com/videojs/doc-generator
- https://github.com/daliwali/docchi
- https://github.com/aef-/hambruger
- https://github.com/llafuente/docr
- https://github.com/verbose/verb
- https://github.com/jonschlinkert/js-comments
JSDoc Parse APIs
- https://github.com/eslint/doctrine - this is what documentation.js uses
- https://github.com/hegemonic/catharsis - what jsdoc uses
- https://github.com/wkeese/js-doc-parse
- https://github.com/jonschlinkert/parse-comments
- https://github.com/Kuniwak/jsdoctypeparser - used by jscs-jsdoc