Skip to content
Lloyd Brookes edited this page Aug 7, 2016 · 9 revisions

Feel free to add your own!

Project Notes
handbrake-js

A module exposing two methods and an inner class. Demonstrates documenting events, linked types and use of `@external` combined with `@see`.The API docs are inserted into this README template by this command:
$ jsdoc2md --template jsdoc2md/README.hbs lib/*.js

command-line-args Demonstrates documentation of ES2015 classes plus the @module, @typicalname, @throws and @alias tags.
array-tools Very simple module exporting a collection of static methods. Demonstrates use of @category to group identifiers in the member-list.
jesucarr/tokenbucket Demonstrates --param-list-format list and the documentation of Promises using the @fulfil and @reject tags.
ansi-escape-sequences Demonstrates usage of @enum {type} (rendered in table format).
Clone this wiki locally