Skip to content

Info about api documentation

Roni Juntunen edited this page Dec 14, 2019 · 1 revision

Info about api documentation

REST-api documentation of this application is generated with apiDoc.

Generating updated documentation

Documentation can be generated with generate_doc.sh script found in the main directory. Generation of the documentation requires apidoc program.

Documentation location

Documentation is inside /backend/routes folder files as a Javadoc comments. See apiDoc sites for more information about formating.

Clone this wiki locally