Dokumentieren von Parametern eines Funktionsparameters in Kotlin

Question

Angenommen, ich habe eine Funktion höherer Ordnung, die eine Art Klick-Listener registriert. Ich kann ihren Zweck und die listener Parameter dokumentieren, wie so übergeben hat:

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

Meine Frage ist, gibt es eine Möglichkeit, die Parameter des listener zu dokumentieren? Dies wäre count in diesem Beispiel. In meinem tatsächlichen Anwendungsfall habe ich mehrere Parameter in meinem Hörer.

Was ich festgestellt habe, ist, dass der Text [listener] klickbar in der Dokumentationsansicht ist, wo ich diese Funktion verwende, aber es zeigt nur einen leeren Dialog darüber. Gibt es eine Möglichkeit, die Parameter dort irgendwie zu beschreiben?

Vorerst habe ich bei der addClickListener Methode mit @param Blöcke beschreiben die Parameter des Hörers beendet, aber dies führt zu einer Warnung in der IDE, und ich frage mich, ob es ein geeigneterer Weg, es zu tun.

Answer 1

Ab Kotlin 1.1 gibt es keine Syntax für die Dokumentation der Parameter oder des Rückgabewerts eines als Funktionsparameter verwendeten Funktionstyps. Es gibt eine open YouTrack issue, die dies abdeckt.