What does it do?
It abbreviates the necessary dependencies for our projects, allowing us to include fewer libraries for our JSDoc generation needs.
Why did we create it?
We also wanted to make our JSDoc output more consistent.
Use NPM to install this library as a
devDependency of your project:
$ npm install --save-dev --save-exact c2cs-jsdoc
Step 1 - Create a JSDoc Config
"source" :"include" :"lib""package.json""README.md""includePattern" : ".js$""excludePattern" : "(node_modules/|docs)""opts" :"destination" : "./doc/html/""template" : "./node_modules/c2cs-jsdoc"
Step 2 - Execute JSDoc
$ cd /path/to/myproject$ node node_modules/c2cs-jsdoc/node_modules/jsdoc/jsdoc.js --configure conf/docs/html.json
The above example is a minimal implementation. You should, at least, add your documentation generation to an "npm script". More information about that is outlined in the Usage Document.