From dc70d1b7bd193ff42e9bed5d80f632cffb85a667 Mon Sep 17 00:00:00 2001
From: Vlad Ureche <vlad.ureche@gmail.com>
Date: Thu, 12 Jul 2012 00:31:25 +0200
Subject: 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.
---
 test/scaladoc/resources/links.scala | 57 +++++++++++++++++++++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 test/scaladoc/resources/links.scala

(limited to 'test/scaladoc/resources/links.scala')

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
+  }
+}
-- 
cgit v1.2.3