From e44f140deb1fc08f3b876707ed30dfd45f9b37ee Mon Sep 17 00:00:00 2001 From: pharkmillups Date: Fri, 9 Dec 2016 12:40:42 -0500 Subject: [PATCH] adding JSDoc courtesy of Steven S. This closes #128. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 910263a..7fa53aa 100644 --- a/README.md +++ b/README.md @@ -110,3 +110,4 @@ This should be updated fairly regularly. As usual, **pull requests are encourage * [Pickles](http://www.picklesdoc.com/#!index.md) - Pickles is an open source living documentation generator that works on feature files written in the Gherkin language. * [ApiDoc](https://github.com/apidoc/apidoc) RESTful web API Documentation Generator that creates documentation from API descriptions in your source code. (contributed by [Trenton Broughton](https://github.com/trenton42)) * [Documentation theme for Jekyll](http://idratherbewriting.com/documentation-theme-jekyll/) - Documentation theme built on Jekyll. Includes detailed notes on how to tackle nearly every technical documentation scenario, from single sourcing to conditional filtering, PDF output, relative links, and more. +* [JSDoc](http://usejsdoc.org/) - Generate JavaScript API documentation directly from source code comments. Also useful as a style guide for JS commenting, in general. Google uses a version of JSDoc tags for its [Closure compiler](https://github.com/google/closure-compiler/wiki/Annotating-JavaScript-for-the-Closure-Compiler).