How do I reference a secondary constructor in KDoc?

Asked Oct 23 '19 at 16:08

Active Oct 23 '19 at 21:23

Viewed 412 times

I have a Kotlin class with a secondary constructor, that is supposed to be used in a certain scenario. Now this should be properly documented from the first constructor so you can see it right away.

/**
* 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")

}

I have not the slightest idea what to put in the square brackets that are meant for referencing members/functions, but I feel it should be possible. Would be great if somebody knows more about this

edited Oct 23 '19 at 21:23

Enselic

4,434
2
30
42

asked Oct 23 '19 at 16:08

Jan Gillich

Your code won't compile `Conflicting overloads` – Dirk Deyne Oct 23 '19 at 17:58
While we wait on the author to update the question you can replace `b: String` with `b: Int` and it will compile. – Enselic Oct 23 '19 at 18:05
1

This is being tracked in [KT-15984](https://youtrack.jetbrains.com/issue/KT-15984), so +1 and follow there. – mkobit Jun 08 '21 at 14:40

How do I reference a secondary constructor in KDoc?

0 Answers0