SI-3695 SI-4224 SI-4497 SI-5079 scaladoc links

Adds the ability to link to members, classes and objects in scaladoc.
The links can now be either qualified names or relative names, they
both work. See the test/scaladoc/resources/links.scala for a usage
example. Also introduced -no-link-warnings scaladoc flag, in case the
build output gets swamped with link warnings.

5 files changed, 102 insertions, 4 deletions

diff --git a/test/scaladoc/resources/links.scala b/test/scaladoc/resources/links.scala
new file mode 100644
index 0000000000..679d0b0dce
--- /dev/null
+++ b/test/scaladoc/resources/links.scala
@@ -0,0 +1,57 @@
+// that would be:
+// SI-5079 "Scaladoc can't link to an object (only a class or trait)"
+// SI-4497 "Links in ScalaDoc - Spec and implementation unsufficient"
+// SI-4224 "Wiki-links should support method targets"
+// SI-3695 "support non-fully-qualified type links in scaladoc comments"
+package scala.test.scaladoc.links {
+  import language.higherKinds
+  class C
+
+  trait Target {
+    type T
+    type S = String
+    class C
+    def foo(i: Int) = 2
+    def foo(s: String) = 3
+    def foo[A[_]](x: A[String]) = 5
+    def foo[A[_[_]]](x: A[List]) = 6
+    val bar: Boolean
+    def baz(c: scala.test.scaladoc.links.C) = 7
+  }
+
+  object Target {
+    type T = Int => Int
+    type S = Int
+    class C
+    def foo(i: Int) = 2
+    def foo(z: String) = 3
+    def foo[A[_]](x: A[String]) = 5
+    def foo[A[_[_]]](x: A[List]) = 6
+    val bar: Boolean = false
+    val onlyInObject = 1
+    def baz(c: scala.test.scaladoc.links.C) = 7
+  }
+
+  /**
+   *  Links to the trait:
+   *  - [[scala.test.scaladoc.links.Target!.T trait Target -> type T]]
+   *  - [[test.scaladoc.links.Target!.S       trait Target -> type S]]
+   *  - [[scaladoc.links.Target!.foo(Int)*    trait Target -> def foo]]
+   *  - [[links.Target!.bar                   trait Target -> def bar]]
+   *  - [[[[Target!.foo[A[_[_]]]*             trait Target -> def foo with 3 nested tparams]]]] (should exercise nested parens)
+   *  - [[Target$.T                           object Target -> type T]]
+   *  - [[Target$.S                           object Target -> type S]]
+   *  - [[Target$.foo(Str*                    object Target -> def foo]]
+   *  - [[Target$.bar                         object Target -> def bar]]
+   *  - [[[[Target$.foo[A[_[_]]]*             trait Target -> def foo with 3 nested tparams]]]] (should exercise nested parens)
+   *  - [[Target.onlyInObject                 object Target -> def foo]] (should find the object)
+   *  - [[Target$.C                           object Target -> class C]] (should link directly to C, not as a member)
+   *  - [[Target!.C                           trait Target -> class C]] (should link directly to C, not as a member)
+   *  - [[Target$.baz(links\.C)*              object Target -> def baz]] (should use dots in prefix)
+   *  - [[Target!.baz(links\.C)*              trait Target -> def baz]] (should use dots in prefix)
+   *  - [[localMethod                         object TEST -> localMethod]] (should use the current template to resolve link instead of inTpl, that's the package)
+   */
+  object TEST {
+    def localMethod = 3
+  }
+}
diff --git a/test/scaladoc/run/SI-5235.scala b/test/scaladoc/run/SI-5235.scala
index f0c6e1cf17..6295fc7786 100644
--- a/test/scaladoc/run/SI-5235.scala
+++ b/test/scaladoc/run/SI-5235.scala
@@ -79,8 +79,8 @@ object Test extends ScaladocModelTest {
     assert(mcReverseType.name == "MyCollection",mcReverseType.name + " == MyCollection")
     assert(gcReverseType.refEntity(0)._1 == LinkToTpl(GenericColl),
            gcReverse.qualifiedName + "'s return type has a link to " + GenericColl.qualifiedName)
-    assert(!scReverseType.refEntity(0)._1.asInstanceOf[LinkToTpl].tpl.isDocTemplate,
-           scReverse.qualifiedName + "'s return type does not have links")
+    assert(scReverseType.refEntity(0)._1 == Tooltip("BullSh"),
+           scReverseType.refEntity(0)._1 + " == Tooltip(\"BullSh\")")
     assert(mcReverseType.refEntity(0)._1 == LinkToTpl(MyCollection),
            mcReverse.qualifiedName + "'s return type has a link to " + MyCollection.qualifiedName)
   }
diff --git a/test/scaladoc/run/links.check b/test/scaladoc/run/links.check
new file mode 100644
index 0000000000..619c56180b
--- /dev/null
+++ b/test/scaladoc/run/links.check
@@ -0,0 +1 @@
+Done.
diff --git a/test/scaladoc/run/links.scala b/test/scaladoc/run/links.scala
new file mode 100644
index 0000000000..40ce6368ce
--- /dev/null
+++ b/test/scaladoc/run/links.scala
@@ -0,0 +1,28 @@
+import scala.tools.nsc.doc.model._
+import scala.tools.partest.ScaladocModelTest
+
+// SI-5079 "Scaladoc can't link to an object (only a class or trait)"
+// SI-4497 "Links in ScalaDoc - Spec and implementation unsufficient"
+// SI-4224 "Wiki-links should support method targets"
+// SI-3695 "support non-fully-qualified type links in scaladoc comments"
+object Test extends ScaladocModelTest {
+
+  override def resourceFile = "links.scala"
+
+  // no need for special settings
+  def scaladocSettings = ""
+
+  def testModel(rootPackage: Package) = {
+    // get the quick access implicit defs in scope (_package(s), _class(es), _trait(s), object(s) _method(s), _value(s))
+    import access._
+
+    // just need to check the member exists, access methods will throw an error if there's a problem
+    val base = rootPackage._package("scala")._package("test")._package("scaladoc")._package("links")
+    val TEST = base._object("TEST")
+
+    val memberLinks = countLinks(TEST.comment.get, _.link.isInstanceOf[LinkToMember])
+    val templateLinks = countLinks(TEST.comment.get, _.link.isInstanceOf[LinkToTpl])
+    assert(memberLinks == 14,  memberLinks +   " == 14 (the member links in object TEST)")
+    assert(templateLinks == 2, templateLinks + " ==  2 (the template links in object TEST)")
+  }
+}
\ No newline at end of file
diff --git a/test/scaladoc/scalacheck/CommentFactoryTest.scala b/test/scaladoc/scalacheck/CommentFactoryTest.scala
index b7869d5bf4..5e3141bdc0 100644
--- a/test/scaladoc/scalacheck/CommentFactoryTest.scala
+++ b/test/scaladoc/scalacheck/CommentFactoryTest.scala
@@ -10,7 +10,13 @@ import scala.tools.nsc.doc.model.diagram._
 
 class Factory(val g: Global, val s: doc.Settings)
   extends doc.model.ModelFactory(g, s) {
-  thisFactory: Factory with ModelFactoryImplicitSupport with ModelFactoryTypeSupport with DiagramFactory with CommentFactory with doc.model.TreeFactory =>
+  thisFactory: Factory
+  with ModelFactoryImplicitSupport
+  with ModelFactoryTypeSupport
+  with DiagramFactory
+  with CommentFactory
+  with doc.model.TreeFactory
+  with MemberLookup =>
 
   def strip(c: Comment): Option[Inline] = {
     c.body match {
@@ -31,7 +37,13 @@ object Test extends Properties("CommentFactory") {
     val settings = new doc.Settings((str: String) => {})
     val reporter = new scala.tools.nsc.reporters.ConsoleReporter(settings)
     val g = new Global(settings, reporter)
-    (new Factory(g, settings) with ModelFactoryImplicitSupport with ModelFactoryTypeSupport with DiagramFactory with CommentFactory with doc.model.TreeFactory)
+    (new Factory(g, settings)
+      with ModelFactoryImplicitSupport
+      with ModelFactoryTypeSupport
+      with DiagramFactory
+      with CommentFactory
+      with doc.model.TreeFactory
+      with MemberLookup)
   }
 
   def parse(src: String, dst: Inline) = {