Escape /* and */ in KDocs

[BoD]

Workaround square/kotlinpoet#887

[apollo-librarian]

✅ Docs preview has no changes

The preview was not built because there were no changes.

Build ID: d1507cf53614e1453e559ce4
Build Logs: View logs

[martinbonnin]

This means code blocks containing /* will probably not be rendered correctly, right? It's better than code not compiling I guess.

[BoD]

No actually I checked, and that's rendered correctly in the IDE and in the generated KDoc

[martinbonnin]

If this string:

```
*
```

Is rendered as this codeblock:

/*

Then how does one displays * in a codeblock?

[BoD]

how does one displays * in a codeblock?

You have to escape the &:

/**
 * /*
 *
 * *
 */

shows like:

[martinbonnin]

What about this?

/**
 * generates some foo!
 * example:
 * 
 * ```kotlin
 * /* this is how you do it! */
 * val foo = doFoo()
 * ```
 */
fun doFoo() = TODO()

[BoD]

Ahhh yes indeed it doesn't work inside code blocks :(

[martinbonnin]

This is fine by me, especially if the current state is to generate non-compiling code but probably means the "good" fix needs to be in Kotlin somewhere?

[BoD]

👍

I've just opened https://youtrack.jetbrains.com/issue/KT-83005/