Antichesse (o ^ω^ o)
4520 shaares
2 résultats
taggé
dokka
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.