L'utilitaire JavaDoc ne fonctionne pas avec du code Kotlin (normal me direz-vous). Heureusement, Jetbrains fourni Dokka sous la forme de plugin Maven et Gradle permettant de faire la même chose.
Les annotations et syntaxes Dokka diffèrent un peu de la JavaDoc, voici un résumé :
@param Identique à JavaDoc
@property Pour documenter un attribut
@constructor Pour documenter un constructeur primaire
@return Identique à JavaDoc
Pour faire un lien vers une _classe/method/autre_ simplement écrire ceci
/** Je veux faire un lien vers [MaClass] **/
et Dokka fera le job
La documentation en Kotlin est produite à partir de Dokka et non le maven-javadoc-plugin (normal puisqu'il s'agit de parler/lexer un autre langage).
Cette page décrit les différences de syntaxe entre la JavaDoc et la KDoc.
Vous utilisez NetBeans, IntelliJ ou Eclipse > 4.5, alors en deux commandes Maven votre IDE pourra intégrer la doc (javadoc) et les sources (pour le mode debug). Cd que Maven va faire c'est de récupérer pour chacune des dépendances les jar des sources et de la JavaDoc si ceux-ci sont disponibles.
mvn dependency:sources
mvn dependency:resolve -Dclassifier=javadoc
Edit : un outil que j'ai appelé mvndoc
.