API Documentation

Intro

The API documentation is automatically created and published to our github page during each release (and no other) build. Have a look at the respective travis script for technical details.

It documents all API functions found in api/src/controllers and is generated by their code comments. This is done with apiDoc.

The documentation can be generated by running npm run apidoc (within the api folder). This will run the gulp task gulp generate:apidoc.

How to maintain the API documentation?

All you need to do is keeping the code comments up-to-date. The rest is taken care of. So please check and adjust the respective comment section when you work on an API function! And when you add a new API function, then add it with a valid apiDoc comment (you can use one of the existing comments as a template).