Skip to content

Commit 2ea25b5

Browse files
authored
Merge pull request #12774 from KacperFKorban/master
scaladoc/fix-escaping-tags
2 parents 75556ad + ad53d20 commit 2ea25b5

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

scaladoc/src/dotty/tools/scaladoc/tasty/comments/markdown/SnippetRenderer.scala

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ package dotty.tools.scaladoc.tasty.comments.markdown
33
import com.vladsch.flexmark.html._
44

55
import dotty.tools.scaladoc.snippets._
6+
import dotty.tools.scaladoc.util.HTML._
67

78
case class SnippetLine(content: String, lineNo: Int, classes: Set[String] = Set.empty, messages: Seq[String] = Seq.empty):
89
def withClass(cls: String) = this.copy(classes = classes + cls)
9-
private def escapeQuotes(msg: String): String = msg.replace("\"", """)
1010
def toHTML =
11-
val label = if messages.nonEmpty then s"""label="${messages.map(escapeQuotes).mkString("\n")}"""" else ""
11+
val label = if messages.nonEmpty then s"""label="${messages.map(_.escapeReservedTokens).mkString("\n")}"""" else ""
1212
s"""<span id="$lineNo" class="${classes.mkString(" ")}" $label>$content</span>"""
1313

1414
object SnippetRenderer:
@@ -89,14 +89,14 @@ object SnippetRenderer:
8989

9090
private def wrapCodeLines(codeLines: Seq[String]): Seq[SnippetLine] =
9191
val snippetLines = codeLines.zipWithIndex.map {
92-
case (content, idx) => SnippetLine(content, idx)
92+
case (content, idx) => SnippetLine(content.escapeReservedTokens, idx)
9393
}
9494
wrapHiddenSymbols
9595
.andThen(wrapSingleLineComments)
9696
.andThen(wrapMultiLineComments)
9797
.apply(snippetLines)
9898

99-
private def addCompileMessages(messages: Seq[SnippetCompilerMessage])(codeLines: Seq[SnippetLine]): Seq[SnippetLine] = //TODO add tooltips and stuff
99+
private def addCompileMessages(messages: Seq[SnippetCompilerMessage])(codeLines: Seq[SnippetLine]): Seq[SnippetLine] =
100100
val messagesDict = messages.filter(_.position.nonEmpty).groupBy(_.position.get.relativeLine).toMap[Int, Seq[SnippetCompilerMessage]]
101101
codeLines.map { line =>
102102
messagesDict.get(line.lineNo) match

scaladoc/src/dotty/tools/scaladoc/util/html.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ object HTML:
3535
sb.append(s"</$name>")
3636
sb
3737

38-
extension (s: String) private def escapeReservedTokens: String =
38+
extension (s: String) def escapeReservedTokens: String =
3939
s.replace("&", "&amp;")
4040
.replace("<", "&lt;")
4141
.replace(">", "&gt;")

0 commit comments

Comments
 (0)