Reference: Kotlin API (KDoc)¶
The Kotlin API reference is generated from KDoc comments by Dokka and published to reference/kdoc/.
To regenerate locally:
mise run docs:api # runs ./gradlew dokkaHtmlCollector, copies output to docs/reference/kdoc/
mise run docs:build # full site including the API reference
What belongs here vs. elsewhere¶
- This page (Dokka) — types, functions, and contracts of the code itself (especially the
domainports and aggregates). - REST API — the external HTTP contract.
- Database — the persisted schema.
KDoc conventions¶
- Document ports (interfaces in
domain/.../port) thoroughly — they are the seams of the system and the most valuable API surface. - Keep comments about intent and invariants, not restatements of the signature (see the project's comment-quality expectations).