SI-5784 Scaladoc: {Abstract,Alias} type templates

Normally scaladoc won't generate template pages for anything other than
packages, classes, traits and objects. But using the @template
annotation on {abstract,alias} types, they get their own page and take
part as full members in the diagrams. Furthermore, when looking for the
companion object, if a value of type T is in scope, T will be taken as
the companion object (even though it might be a class)

All templates, including types are listed on the left navigation pane,
so now adding @template to String can get scaladoc to generate (a
no-comments) page for java.lang.String.

The {abstract, alias} type icons need to be updated -- I just took the
class icons and added a small x to them -- but they shoud be something
else (maybe an underscore?)i

TO USE THIS PATCH:
<pre>
/** @contentDiagram */ // tells scaladoc to create a diagram of the
                       // templates contained in trait Base
trait Base {
  /** @template */ // tells scaladoc to create a page for Foo
  type T < Foo
  trait Foo { def foo: Int }
}

/** @contentDiagram */
trait Api extends Base {
  /** @template */
  override type T <: FooApi
  trait FooApi extends Foo { def bar: String }
}
</pre>

5 files changed, 77 insertions, 1 deletions

diff --git a/test/scaladoc/resources/SI-5784.scala b/test/scaladoc/resources/SI-5784.scala
new file mode 100644
index 0000000000..175cc3cf33
--- /dev/null
+++ b/test/scaladoc/resources/SI-5784.scala
@@ -0,0 +1,28 @@
+package test.templates {
+  object `package` {
+    /** @template */
+    type String = java.lang.String
+    val String = new StringCompanion
+    class StringCompanion { def boo = ??? }
+  }
+
+  /** @contentDiagram */
+  trait Base {
+    /** @template */
+    type String = test.templates.String
+    /** @template
+     * @inheritanceDiagram */
+    type T <: Foo
+    val T: FooExtractor
+    trait Foo { def foo: Int }
+    trait FooExtractor { def apply(foo: Int); def unapply(t: Foo): Option[Int] }
+  }
+
+  /** @contentDiagram */
+  trait Api extends Base {
+    /** @template
+     *  @inheritanceDiagram */
+    override type T <: FooApi
+    trait FooApi extends Foo { def bar: String }
+  }
+}
diff --git a/test/scaladoc/resources/doc-root/AnyRef.scala b/test/scaladoc/resources/doc-root/AnyRef.scala
index 1eefb0c806..7d8b9f9e76 100644
--- a/test/scaladoc/resources/doc-root/AnyRef.scala
+++ b/test/scaladoc/resources/doc-root/AnyRef.scala
@@ -10,6 +10,7 @@ package scala
 
 /** Class `AnyRef` is the root class of all ''reference types''.
  *  All types except the value types descend from this class.
+ *  @template
  */
 trait AnyRef extends Any {
 
diff --git a/test/scaladoc/run/SI-5533.scala b/test/scaladoc/run/SI-5533.scala
index e7b5f57860..989d9aa13a 100644
--- a/test/scaladoc/run/SI-5533.scala
+++ b/test/scaladoc/run/SI-5533.scala
@@ -32,6 +32,8 @@ object Test extends ScaladocModelTest {
     val B = b._class("B")
     val D = b._class("D")
     testDiagram(B, B.contentDiagram, 2, 1)
-    testDiagram(D, D.contentDiagram, 2, 1)
+    // unfortunately not all packages, as B1 extends A.this.A1 and it gets the wrong member -- maybe we should model
+    // things as we do for symbols?
+    testDiagram(D, D.contentDiagram, 3, 2)
   }
 }
\ No newline at end of file
diff --git a/test/scaladoc/run/SI-5784.check b/test/scaladoc/run/SI-5784.check
new file mode 100644
index 0000000000..619c56180b
--- /dev/null
+++ b/test/scaladoc/run/SI-5784.check
@@ -0,0 +1 @@
+Done.
diff --git a/test/scaladoc/run/SI-5784.scala b/test/scaladoc/run/SI-5784.scala
new file mode 100644
index 0000000000..318eb78b2a
--- /dev/null
+++ b/test/scaladoc/run/SI-5784.scala
@@ -0,0 +1,44 @@
+import scala.tools.nsc.doc.model._
+import scala.tools.partest.ScaladocModelTest
+
+object Test extends ScaladocModelTest {
+
+  override def resourceFile: String = "SI-5784.scala"
+
+  // no need for special settings
+  def scaladocSettings = "-diagrams"
+
+  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._
+
+    val main = rootPackage._package("test")._package("templates")
+
+    val String = main._aliasTypeTpl("String")
+    assert(String.companion.isDefined, "test.templates.String should have a pseudo-companion object")
+
+    val Base = main._trait("Base")
+    assert(Base.members.filter(_.inDefinitionTemplates.head == Base).length == 5, Base.members.filter(_.inDefinitionTemplates.head == Base).length + " == 5")
+    assert(Base.members.collect{case d: DocTemplateEntity => d}.length == 4, Base.members.collect{case d: DocTemplateEntity => d}.length == 4)
+    testDiagram(Base, Base.contentDiagram, 2, 1)
+
+    val BaseT = Base._absTypeTpl("T")
+    val Foo = Base._trait("Foo")
+    assert(BaseT.members.filter(_.inDefinitionTemplates.head == Base).length == 0, BaseT.members.filter(_.inDefinitionTemplates.head == Base).length + " == 0")
+    assert(BaseT.members.map(_.name).sorted == Foo.members.map(_.name).sorted, BaseT.members.map(_.name).sorted + " == " + Foo.members.map(_.name).sorted)
+    assert(BaseT.companion.isDefined, "test.templates.Base.T should have a pseudo-companion object")
+    testDiagram(BaseT, BaseT.inheritanceDiagram, 2, 1)
+
+    val Api = main._trait("Api")
+    assert(Api.members.filter(_.inDefinitionTemplates.head == Api).length == 2, Api.members.filter(_.inDefinitionTemplates.head == Api).length + " == 2") // FooApi and override type T
+    assert(Api.members.collect{case d: DocTemplateEntity => d}.length == 5, Api.members.collect{case d: DocTemplateEntity => d}.length == 5)
+    testDiagram(Api, Api.contentDiagram, 3, 2)
+
+    val ApiT = Api._absTypeTpl("T")
+    val FooApi = Api._trait("FooApi")
+    assert(ApiT.members.filter(_.inDefinitionTemplates.head == Api).length == 0, ApiT.members.filter(_.inDefinitionTemplates.head == Api).length + " == 0")
+    assert(ApiT.members.map(_.name).sorted == FooApi.members.map(_.name).sorted, ApiT.members.map(_.name).sorted + " == " + FooApi.members.map(_.name).sorted)
+    assert(ApiT.companion.isDefined, "test.templates.Api.T should have a pseudo-companion object")
+    testDiagram(ApiT, ApiT.inheritanceDiagram, 2, 1)
+  }
+}
\ No newline at end of file