Handle escaped markdown characters in KDoc

Summary: We never encountered that until now, so all it required was handling this case as well. Fixes #329 Reviewed By: cgrushko Differential Revision: D37038044 fbshipit-source-id: 21d89dc7186f6e46369980d94a97da8548a0f793
facebook · Jun 9, 2022 · 5f7b063 · 5f7b063
1 parent 0b5d3d1
commit 5f7b063
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/core/src/main/java/com/facebook/ktfmt/kdoc/KDocFormatter.kt b/core/src/main/java/com/facebook/ktfmt/kdoc/KDocFormatter.kt
@@ -98,6 +98,7 @@ object KDocFormatter {
       KDocTokens.MARKDOWN_LINK -> {
         tokens.add(KDocToken(MARKDOWN_LINK, tokenText))
       }
+      KDocTokens.MARKDOWN_ESCAPED_CHAR,
       KDocTokens.TEXT -> {
         var first = true
         for (word in tokenizeKdocText(tokenText)) {

diff --git a/core/src/test/java/com/facebook/ktfmt/format/FormatterTest.kt b/core/src/test/java/com/facebook/ktfmt/format/FormatterTest.kt
@@ -1721,6 +1721,14 @@ class FormatterTest {
       | */
       |""".trimMargin())
 
+  @Test
+  fun `formatting kdoc with markdown errors`() =
+      assertFormatted(
+          """
+      |/** \[ */
+      |fun markdownError() = Unit
+      |""".trimMargin())
+
   @Test
   fun `return statement with value`() =
       assertFormatted(