jsdoc-to-markdown
Generates markdown documentation from jsdoc annotated source code. Useful for injecting API docs into project README files.
Synopsis
1. Document your code using valid jsdoc comments.
function protection (cloak, dagger) {}
2. Run a command.
$ jsdoc2md example.js
3. Get markdown output.
## protection(cloak, dagger) ⇒ <code>survival</code>
A quite wonderful function.
**Kind**: global function
| Param | Type | Description |
| ------ | ------------------- | ------------ |
| cloak | <code>object</code> | privacy gown |
| dagger | <code>object</code> | security |
Install
$ npm i -g jsdoc-to-markdown@^2.0.0-alpha
See also
© 2014-16 Lloyd Brookes 75pound@gmail.com.