Search code examples
kotlinkdockotlin-dokka

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?


Solution

  • 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.