|
|
|
## Code Documentation with JSDoc
|
|
|
|
|
|
|
|
### For reference how to comment with JSDOC, look here
|
|
|
|
- JSDoc Documentation http://usejsdoc.org/
|
|
|
|
|
|
|
|
### Reference implementation for the JSDoc Comments
|
|
|
|
- Can be found in the folder `documentation/reference`
|
|
|
|
|
|
|
|
### Node modules which are Dependencies for JSDoc and the DocStrap template
|
|
|
|
- jsdoc
|
|
|
|
- ink-docstrap (a html template for the output of jsdoc)
|
|
|
|
|
|
|
|
### Generating the Documentation
|
|
|
|
[from the project root]
|
|
|
|
|
|
|
|
`./node_modules/jsdoc/jsdoc.js -c documentation/conf.json -d [OUTPUT_FOLDER] -t ./node_modules/ink-docstrap/template/ -r`
|
|
|
|
|
|
|
|
### Configuration of JSDoc
|
|
|
|
The configuration file can be found here: documentation/conf.json
|
|
|
|
|
