Допустим, у меня есть функция более высокого порядка, которая регистрирует своего рода прослушиватель кликов. Я могу задокументировать его назначение и переданный параметр listener
следующим образом:
/**
* Adds a [listener] that's called when the item is clicked.
*
* @param listener The listener to add
*/
fun addClickListener(listener: (count: Int) -> Unit) {
...
}
Мой вопрос: есть ли способ документировать параметры listener
? В данном примере это будет count
. В моем реальном случае использования у меня есть несколько параметров в моем слушателе.
Что я заметил, так это то, что текст [listener]
можно щелкнуть в представлении документации, где я использую эту функцию, но он просто показывает пустой диалог об этом. Есть ли способ описать параметры там как-то?
На данный момент я закончил описание параметров прослушивателя с блоками @param
в методе addClickListener
, но это приводит к предупреждению в IDE, и мне интересно, есть ли более правильный способ сделать это.