Merge pull request #14377 from KacperFKorban/fix-i13746

Scaladoc: Unescaped special characters in Quotes documentation
scala · Feb 7, 2022 · 064c213 · 064c213
2 parents 8e2fab7 + 1f280bb
commit 064c213
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/scaladoc-testcases/src/tests/markdowncode.scala b/scaladoc-testcases/src/tests/markdowncode.scala
@@ -0,0 +1,5 @@
+package tests.markdowncode
+
+/** Some text `{ <statements: List[Statement]>; <expr: Term> }` */
+val aVal: Float
+  = 1.2f
diff --git a/scaladoc/src/dotty/tools/scaladoc/renderers/DocRenderer.scala b/scaladoc/src/dotty/tools/scaladoc/renderers/DocRenderer.scala
@@ -86,7 +86,7 @@ class DocRender(signatureRenderer: SignatureRenderer)(using DocContext):
     case Subscript(text) => span(cls:="subscript")(renderElement(text))  // TODO implement style
     case Link(target, body) =>
       renderLink(target, default => body.fold[TagArg](default)(renderElement))
-    case Text(text) => raw(text)
+    case Text(text) => raw(text.escapeReservedTokens)
     case Summary(text) => renderElement(text)
     case HtmlTag(content) => raw(content)
 

diff --git a/scaladoc/test/dotty/tools/scaladoc/signatures/TranslatableSignaturesTestCases.scala b/scaladoc/test/dotty/tools/scaladoc/signatures/TranslatableSignaturesTestCases.scala
@@ -92,3 +92,5 @@ class FBoundedTypeParameters extends SignatureTest("fboundedTypeParameters", Sig
 class Exports extends SignatureTest("exports2", SignatureTest.all, sourceFiles = List("exports1", "exports2"))
 
 class ContextFunctions extends SignatureTest("contextfunctions", SignatureTest.all)
+
+class MarkdownCode extends SignatureTest("markdowncode", SignatureTest.all)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -92,3 +92,5 @@ class FBoundedTypeParameters extends SignatureTest("fboundedTypeParameters", Sig
		class Exports extends SignatureTest("exports2", SignatureTest.all, sourceFiles = List("exports1", "exports2"))

		class ContextFunctions extends SignatureTest("contextfunctions", SignatureTest.all)

		class MarkdownCode extends SignatureTest("markdowncode", SignatureTest.all)