Skip to content

Commit 1d9c061

Browse files
committed
Scaladoc: Unescaped special characters in Quotes documentation
closes scala#13746
1 parent 3c82006 commit 1d9c061

File tree

3 files changed

+9
-2
lines changed

3 files changed

+9
-2
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
package tests.markdowncode
2+
3+
/** Some text `{ <statements: List[Statement]>; <expr: Term> }` */
4+
val aVal: Float
5+
= 1.2f

scaladoc/src/dotty/tools/scaladoc/renderers/DocRenderer.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,12 @@ class DocRender(signatureRenderer: SignatureRenderer)(using DocContext):
8181
case Italic(text) => span(cls:="italic")(renderElement(text))
8282
case Underline(text) => span(cls:="underline")(renderElement(text))
8383
case Bold(text) => span(cls:="bold")(renderElement(text))
84-
case Monospace(text) => code(renderElement(text))
84+
case Monospace(text) => code(renderElement(text)) // escape
8585
case Superscript(text) => span(cls:="superscript")(renderElement(text)) // TODO implement style
8686
case Subscript(text) => span(cls:="subscript")(renderElement(text)) // TODO implement style
8787
case Link(target, body) =>
8888
renderLink(target, default => body.fold[TagArg](default)(renderElement))
89-
case Text(text) => raw(text)
89+
case Text(text) => raw(text.escapeReservedTokens)
9090
case Summary(text) => renderElement(text)
9191
case HtmlTag(content) => raw(content)
9292

scaladoc/test/dotty/tools/scaladoc/signatures/TranslatableSignaturesTestCases.scala

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,3 +90,5 @@ class ContextBounds extends SignatureTest("contextBounds", SignatureTest.all)
9090
class FBoundedTypeParameters extends SignatureTest("fboundedTypeParameters", SignatureTest.all)
9191

9292
class Exports extends SignatureTest("exports2", SignatureTest.all, sourceFiles = List("exports1", "exports2"))
93+
94+
class MarkdownCode extends SignatureTest("markdowncode", SignatureTest.all)

0 commit comments

Comments
 (0)