Можно ли в документации Kotlin (KDoc) указать конкретный перегруженный метод?

Рассмотрим комментарий класса этого класса Kotlin:

/**
 * This class has two methods, one that takes one parameters ([foo]),
 * and another one that takes two parameters ([foo]).
 **/
class Clazz {
    /* Foo with one. */
    fun foo(a: Int) {  }

    /* Foo with two. */
    fun foo(a: Int, b: Int) {  }
}

Я бы хотел, чтобы вторая ссылка указывала на вторую функцию (с двумя параметрами).

Возможно ли это на языке документации Kotlin?


kotlin kdoc dokka
person treesAreEverywhere    schedule 18.12.2019    source источник
comment
Связанная ошибка/отсутствующая функция   -  person Roland    schedule 31.01.2020
comment
См. также KT-15984.   -  person Bass    schedule 03.02.2020

Ответы (1)


arrow_upward
9
arrow_downward

Только что нашел этот ответ:

Обратите внимание, что KDoc не имеет синтаксиса для разрешения перегруженных элементов в ссылках. Поскольку инструмент генерации документации Kotlin помещает документацию для всех перегрузок функции на одну страницу, для работы ссылки не требуется указывать конкретную перегруженную функцию.

Из https://kotlinlang.org/docs/reference/kotlin-doc.html

... но я не очень понимаю аргументацию.

Похоже, это имеет смысл в контексте, когда документы читаются отдельно от кода, но большую часть времени, когда я читаю или использую комментарии, это происходит в пользовательском интерфейсе IDE.

person treesAreEverywhere    schedule 18.12.2019