Hi, newbie to Kotlin and Dokka here, probably a si...
# dokka
j
Hi, newbie to Kotlin and Dokka here, probably a silly question... I have a
data class
for which I have documented properties using `@property`:
Copy code
/**
 * Class description blah, blah, blah.
 *
 * @property property Something. Another something. And blah, blah, blah.
 * 
 * @constructor Creates a new instance, blah, blah.
 */
data class MyClass(val property: String)
The problem I have is that when I browse the class' properties I only get the first
Something.
in the description of the property (up to the first period), and then if I click on the property I get to a new page listing the property with no description at all, not even the first
Something.
. Am I doing anything wrong? Are periods forbidden in the description of a property?
m
I think that’s weird, i’ll debug it and let you know
Uh, it is messed up a little in dokka 😄 https://github.com/Kotlin/dokka/issues/1899
j
ok, so it wasn't my fault 🙂 I guess then that if I put it before the property itself it would work properly?
thanks a lot, by the way 🙂
Answering to my own question, and in case anybody else lands here, this works properly:
Copy code
/**
 * Class description blah, blah, blah.
 *
 * @constructor Creates a new instance, blah, blah.
 */
data class MyClass(
    /** Something. Another something. And blah, blah, blah. */
    val property: String
)