I’m writing an API in Kotlin and I need to document a class that holds tri-state properties (true/null/false). I’m trying to write details of that each state do and I think it is visually better to have one line for each state.
/**
* The visual style of a text.
*
* All properties have a tri-state value: `true`/`null`/`false`
*
* A `true` value specifies that the effect is applied.
* A `null` value specifies that the parent style must be checked to decide if the effect is applied or not.
* A `false` value specifies that the effect must not be applied regardless if the parent style applies it or not.
*/
data class Style(val sample: Boolean?)
The problem is that the last lines are not breaking and the documentation is being rendered like this:
The visual style of a text.
All properties have a tri-state value: true/null/false
A true value specifies that the effect is applied. A null value specifies that the parent style must be checked to decide if the effect is applied or not. A false value specifies that the effect must not be applied regardless if the parent style applies it or not.
How do I fix that?