#130 Escaping markup
[Kotlin/dokka] Issue created by
leksak
Is it possible to escape markup inside a doc-comment? As a concrete example, I want to write
/**
• Will tokenize a String using commas as the default delimiter.
• All leading and trailing whitespace is trimmed. All whitespace
• within the String are ignored in the tokenization process. For
• an example we get that "iname rd, rs, rt".tokenize() yields
• ["iname", "rd", "rs", "rt"] and that "10($t0)".tokenize("(")
• yields ["10", "$t0"]
•
• @param delimiter the character that delimits tokens
*/
and of course
[]
is interpreted as a link.
Unresolved link to iname,rd,rs,rt in doc comment of common.extensions$tokenize(kotlin.String, kotlin.String) (StringExtensions.kt:35)
Unresolved link to 10,$t0 in doc comment of common.extensions$tokenize(kotlin.String, kotlin.String) (StringExtensions.kt:35)
Writing `arrayOf`becomes rather verbose and obscures the point. So, is it possible to escape markup somehow?
{@code ...}
is seemingly not a supported form of markup (
https://kotlinlang.org/docs/reference/kotlin-doc.html)