Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to escape symbols in Kotlin documentation Dokka/Kdoc?

I want to add a comment like this

  /**
   * @param scrollFraction In range [0..1].
   */

But Dokka/Kdoc interprets stuff inside square brackets as a reference. This leads to badly rendered comments when you check the function's documentation in the IDE or generate the docs. How can I escape square brackets/other symbols in Dokka/Kdoc?

like image 802
Dmitry Ryadnenko Avatar asked Dec 24 '22 01:12

Dmitry Ryadnenko


2 Answers

You should be able to do it using ` symbol, like this:

 /**
  * @param scrollFraction In range `[0..1]`.
  */

However, using ` symbol will show everything in between as a code block.

To just use square brackets without a reference inside, use HTML symbols, like [ and ] from the @yuvgin's answer.

like image 112
Demigod Avatar answered Jan 14 '23 17:01

Demigod


You can use HTML escaping:

 /**
   * @param scrollFraction In range [0..1].
   */

should output in Dokka as range [0..1]., since [ escapes as [ and ] escapes as ].

Note this will not work inside a section of inline code (between grave accents - like this).
For such cases use square brackets ([ and ]) normally, as was suggested in Demigod's answer.

like image 21
yuvgin Avatar answered Jan 14 '23 16:01

yuvgin