Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Using an annotation in code blocks breaks Dokka parsing #1910

Closed
IngoHaumann-TomTom opened this issue May 10, 2021 · 2 comments · Fixed by #2418
Closed

Using an annotation in code blocks breaks Dokka parsing #1910

IngoHaumann-TomTom opened this issue May 10, 2021 · 2 comments · Fixed by #2418
Labels

Comments

@IngoHaumann-TomTom
Copy link

Using Kotlin annotations in code blocks, breaks the parsing and messes up the output. We have to escape the leading @ in order for Dokka to produce the expected output. All other Markdown tools we use do not have this issue and rightfully show the back slash in their output when we escape the annotation.

Expected behaviour
Anything between triple back ticks is added to the documentation verbatim.

To Reproduce
Use the following snippet: (I'm using an image as I cannot escape triple back ticks here.)
image

Screenshots
The above produces this output:
image

Installation

  • Operating system: Linux
  • Build tool: Gradle v7.0
  • Dokka version: 1.4.32
@jakobkmar
Copy link

The behaviour for me is that markdown just completly breaks after an annotation and everything after it is missing from the generated output. Also, escaping it does not work anymore.

@IgnatBeresnev
Copy link
Member

IgnatBeresnev commented Apr 11, 2022

Partially fixed in the upcoming 1.6.20. The fix will solve the majority of problems, although some corner cases may still arise

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants