Как мне ссылаться на вторичный конструктор в KDoc?

Question

У меня есть класс Kotlin со вторичным конструктором, который должен использоваться в определенном сценарии. Теперь это должно быть должным образом задокументировано из первого конструктора, чтобы вы могли сразу это увидеть.

/**
* This is my class.
* 
* @constructor This is the primary constructor meant for Scenario A.
* If you are in Scenario B, please use [reference to secondary constructor] <- what do I put in here?
*/
class MyClass(val a: String) {

    constructor(b: Int) : this("$b abc")

}

Я не имею ни малейшего представления, что заключать в квадратные скобки, предназначенные для ссылок на элементы / функции, ноЯ чувствую, что это должно быть возможно. Было бы здорово, если бы кто-то знал об этом больше ?

Answer 1

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