Documenter les paramètres d'un paramètre de fonction dans Kotlin

Question

Disons que j'ai une fonction d'ordre supérieur, qui enregistre une sorte d'écouteur de clic. Je peux documenter son but et le paramètre listener qui est passé dans comme ceci:

/** 
* Adds a [listener] that's called when the item is clicked. 
* 
* @param listener The listener to add 
*/ 
fun addClickListener(listener: (count: Int) -> Unit) { 
    ... 
} 

Ma question est, est-il un moyen de documenter les paramètres du listener? Ce serait count dans cet exemple. Dans mon cas d'utilisation actuel, j'ai plusieurs paramètres dans mon écouteur. Ce que j'ai remarqué, c'est que le texte [listener] est cliquable dans l'affichage de la documentation où j'utilise cette fonction, mais il montre juste une boîte de dialogue vide à ce sujet. Existe-t-il un moyen de décrire les paramètres d'une manière ou d'une autre?

Pour l'instant, j'ai fini par décrire les paramètres de l'auditeur avec @param blocs à la méthode addClickListener, mais cela se traduit par un avertissement dans l'IDE, et je me demande s'il y a un moyen plus approprié de le faire.

Answer 1

A partir de Kotlin 1.1, il n'y a pas de syntaxe pour documenter les paramètres ou la valeur de retour d'un type de fonction utilisé comme paramètre de fonction. Il y a un open YouTrack issue couvrant ceci.