SI-3314 SI-4888 Scaladoc: Relative type prefixes

And adds support for linking to class members, only usable from the
model factory now, so no links to members from the doc comment yet,
sorry. But it fixes the Enumeration problem once and for all!

Also corrected the inTpl for members obtained by implicit conversions,
so they're in the correct template and the comment variable expansion
is done from the correct (but different) template.

Review by @kzys.

1 files changed, 74 insertions, 0 deletions

diff --git a/test/scaladoc/run/SI-3314.scala b/test/scaladoc/run/SI-3314.scala
new file mode 100644
index 0000000000..665223098a
--- /dev/null
+++ b/test/scaladoc/run/SI-3314.scala
@@ -0,0 +1,74 @@
+import scala.tools.nsc.doc.model._
+import scala.tools.partest.ScaladocModelTest
+
+object Test extends ScaladocModelTest {
+
+  override def resourceFile = "SI-3314.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")
+
+    val test1 = base._package("test1")
+    val test1Value = test1._class("Enum")._method("Value").resultType
+    assert(test1Value.name == "Value",       test1Value.name + " == Value")
+    assert(test1Value.refEntity.size == 1, test1Value.refEntity.size + " == 1")
+
+    val test1Constants = test1._object("Constants")._method("a").resultType
+    assert(test1Constants.name == "Value", test1Constants.name + " == Value")
+    assert(test1Constants.refEntity.size == 1, test1Constants.refEntity.size + " == 1")
+    assert(test1Constants.refEntity(0)._1 == LinkToMember(test1._object("Constants")._class("Value"), test1._object("Constants")),
+           test1Constants.refEntity(0)._1 + " == LinkToMember(test1.Enum.Value)")
+
+    val test2 = base._package("test2")
+    def testDefinition(doc: DocTemplateEntity) = {
+      for (day <- List("Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun")) {
+        assert(doc._value(day).resultType.name == "Value",
+               doc._value(day).resultType.name + " == Value")
+        assert(doc._value(day).resultType.refEntity.size == 1,
+               doc._value(day).resultType.refEntity.size + " == 1")
+        assert(doc._value(day).resultType.refEntity(0)._1 == LinkToMember(doc._classMbr("Value"), doc),
+               doc._value(day).resultType.refEntity(0)._1 + " == LinkToMember(" + doc.qualifiedName + ".Value)")
+      }
+    }
+    testDefinition(test2._trait("WeekDayTrait"))
+    testDefinition(test2._class("WeekDayClass"))
+    testDefinition(test2._object("WeekDayObject"))
+
+    def testUsage(doc: DocTemplateEntity) = {
+      val ValueInClass = test2._class("WeekDayClass")._classMbr("Value")
+      val ValueInTrait = test2._trait("WeekDayTrait")._classMbr("Value")
+      val ValueInObject = test2._object("WeekDayObject")._classMbr("Value")
+      val WeekDayInObject = test2._object("WeekDayObject")._member("WeekDay")
+
+      val expected = List(
+        ("isWorkingDay1", "Value",   ValueInClass),
+        ("isWorkingDay2", "Value",   ValueInClass),
+        ("isWorkingDay3", "Value",   ValueInTrait),
+        ("isWorkingDay4", "Value",   ValueInTrait),
+        ("isWorkingDay5", "Value",   ValueInObject),
+        ("isWorkingDay6", "WeekDay", WeekDayInObject),
+        ("isWorkingDay7", "Value",   ValueInObject),
+        ("isWorkingDay8", "WeekDay", WeekDayInObject),
+        ("isWorkingDay9", "Value",   ValueInObject))
+
+      for ((method, name, ref) <- expected) {
+        assert(doc._method(method).valueParams(0)(0).resultType.name == name,
+               doc._method(method).valueParams(0)(0).resultType.name + " == " + name + " (in " + doc + "." + method + ")")
+        assert(doc._method(method).valueParams(0)(0).resultType.refEntity.size == 1,
+               doc._method(method).valueParams(0)(0).resultType.refEntity.size + " == " + 1 + " (in " + doc + "." + method + ")")
+        assert(doc._method(method).valueParams(0)(0).resultType.refEntity(0)._1 == LinkToMember(ref, ref.inTemplate),
+               doc._method(method).valueParams(0)(0).resultType.refEntity(0)._1 + " == LinkToMember(" + ref.qualifiedName + ") (in " + doc + "." + method + ")")
+      }
+    }
+    testUsage(test2._object("UserObject"))
+    testUsage(test2._class("UserClass"))
+    testUsage(test2._trait("UserTrait"))
+  }
+}
\ No newline at end of file