I need a NodeJS based generator that takes as input a JavaScript file and generate markdown documentation.
Example:
/**
* foo
* foo description
*
* @name foo
* @param {String} a Some description
* @param {Object} b An object param
* @return {Boolean} Some foo again
*/
function foo (a, b) {
/* do something */
return Boolean(...);
}
The result will be something like this:
## foo (a, b)
foo description
- `a` (String): Some description
- `b` (Object): An object param
Returns (Boolean) Some foo again