KDoc - Primary Constructor


#1

I am a Kotlin Newbie just getting started with the basics (Kotlin + Gradle + KDoc/Dokka).

While creating a simple documented Kotlin class with a primary constructor I noticed that the documentation for the class itself and the ‘init’ constructor are the same.

Normally a class documentation would be something like “A Foobar that is used to do this.” and a constructor documentation would be something like “Creates a new Foobar instance with the given name.”.

However, I end up with a documented constructor with the class description - is there a way to separate the class documentation from the primary constructor documentation?


#2

mmm scratch that… as soon as I asked I figured it out:

@constructor Creates a new Foobar instance with the given name