Add support for backticks in scaladoc links

danicheg · danicheg · commit 242563eb89a7 · 2022-08-01T16:45:12.000+03:00
diff --git a/src/scaladoc/scala/tools/nsc/doc/base/MemberLookupBase.scala b/src/scaladoc/scala/tools/nsc/doc/base/MemberLookupBase.scala
@@ -154,8 +154,13 @@ trait MemberLookupBase {
     result
   }
 
+  private def removeBackticks(member: String): String =
+    if (member.matches("(`).+\\1"))
+      member.substring(1, member.length() - 1)
+    else member
+
   private def lookupInTemplate(pos: Position, member: String, container: Symbol, strategy: SearchStrategy): List[Symbol] = {
-    val name = member.stripSuffix("$").stripSuffix("!").stripSuffix("*")
+    val name = removeBackticks(member.stripSuffix("$").stripSuffix("!").stripSuffix("*"))
     def signatureMatch(sym: Symbol): Boolean = externalSignature(sym).startsWith(name)
 
     // We need to cleanup the bogus classes created by the .class file parser. For example, [[scala.Predef]] resolves
diff --git a/test/scaladoc/run/t12628.check b/test/scaladoc/run/t12628.check
@@ -0,0 +1 @@
+Done.
diff --git a/test/scaladoc/run/t12628.scala b/test/scaladoc/run/t12628.scala
@@ -0,0 +1,32 @@
+import scala.tools.nsc.doc.base._
+import scala.tools.nsc.doc.base.comment._
+import scala.tools.nsc.doc.model._
+import scala.tools.partest.ScaladocModelTest
+
+object Test extends ScaladocModelTest {
+
+  override def code = """
+
+package org.foo
+
+class `Foo-Bar`
+
+object Foo {
+  /**
+    * This returns [[org.foo.`Foo-Bar`]]
+    */
+  def test(): `Foo-Bar` = ???
+}
+    """
+
+  def scaladocSettings = ""
+
+  def testModel(rootPackage: Package) = {
+    import access._
+
+    val body = rootPackage._package("org")._package("foo")._object("Foo")._method("test").comment.get.body
+    
+    val links = countLinksInBody(body, _.link.isInstanceOf[LinkToTpl[_]])
+    assert(links == 1, links + " ==  1 (links to Foo-Bar)")
+  }
+}
