search

Agilis-Ingenium / api.nubadoo.com

Backend for the Health Tracker App.
0 stars 0 forks source link

Implement Comments + KDocs #50

Closed Warren-Byron closed 10 months ago

Warren-Byron commented 10 months ago

Want to standardise my comments so the generate useful documentation

Also revise over the Labs and get KDocs documentation generator working

Warren-Byron commented 10 months ago

Review the creation of a standard comment template:

https://github.com/Agilis-Ingenium/research-plan-design/blob/ec1f072ab9cfcf38c9110a019894f9dfcf6bbcf2/knowledge-base/comments.md

Warren-Byron commented 10 months ago

Lab 1 had KDocs setup for Gradle

We are now using Maven

Therefore use:

https://kotlinlang.org/docs/dokka-maven.html#generate-documentation