Scaladoc: Inherited templates in diagrams

Related to SI-3314, where we started showing inherited templates
that were normally not documented. This patch corrects a problem
in parentTypes that was preventing inherited templates from being
displayed in diagrams.

Also renamed:
PackageDiagram => ContentDiagram
ClassDiagram => InheritanceDiagram
which should have been done much earlier

4 files changed, 119 insertions, 3 deletions

diff --git a/test/scaladoc/resources/SI-3314-diagrams.scala b/test/scaladoc/resources/SI-3314-diagrams.scala
new file mode 100644
index 0000000000..b80a97b522
--- /dev/null
+++ b/test/scaladoc/resources/SI-3314-diagrams.scala
@@ -0,0 +1,78 @@
+package scala.test.scaladoc {
+
+  /** Check the interaction between SI-3314 and diagrams
+   *  - the three enumerations below should get valid content diagrams:
+   *                       Value
+   *              __________/|\__________
+   *             /   /   /   |   \   \   \
+   *            Mon Tue Wed Thu Fri Sat Sun
+   *
+   *  - each member should receive an inhertiance diagram:
+   *                       Value
+   *                         |
+   *                         |
+   *           {Mon,Tue,Wed,Thu,Fri,Sat,Sun}
+   */
+  package diagrams {
+
+    /** @contentDiagram
+     *  @inheritanceDiagram hideDiagram */
+    trait WeekDayTraitWithDiagram extends Enumeration {
+      type WeekDay = Value
+      /** @inheritanceDiagram */
+      object Mon extends WeekDay
+      /** @inheritanceDiagram */
+      object Tue extends WeekDay
+      /** @inheritanceDiagram */
+      object Wed extends WeekDay
+      /** @inheritanceDiagram */
+      object Thu extends WeekDay
+      /** @inheritanceDiagram */
+      object Fri extends WeekDay
+      /** @inheritanceDiagram */
+      object Sat extends WeekDay
+      /** @inheritanceDiagram */
+      object Sun extends WeekDay
+    }
+
+    /** @contentDiagram
+     *  @inheritanceDiagram hideDiagram */
+    class WeekDayClassWithDiagram extends Enumeration {
+      type WeekDay = Value
+      /** @inheritanceDiagram */
+      object Mon extends WeekDay
+      /** @inheritanceDiagram */
+      object Tue extends WeekDay
+      /** @inheritanceDiagram */
+      object Wed extends WeekDay
+      /** @inheritanceDiagram */
+      object Thu extends WeekDay
+      /** @inheritanceDiagram */
+      object Fri extends WeekDay
+      /** @inheritanceDiagram */
+      object Sat extends WeekDay
+      /** @inheritanceDiagram */
+      object Sun extends WeekDay
+    }
+
+    /** @contentDiagram
+     *  @inheritanceDiagram hideDiagram */
+    object WeekDayObjectWithDiagram extends Enumeration {
+      type WeekDay = Value
+      /** @inheritanceDiagram */
+      object Mon extends WeekDay
+      /** @inheritanceDiagram */
+      object Tue extends WeekDay
+      /** @inheritanceDiagram */
+      object Wed extends WeekDay
+      /** @inheritanceDiagram */
+      object Thu extends WeekDay
+      /** @inheritanceDiagram */
+      object Fri extends WeekDay
+      /** @inheritanceDiagram */
+      object Sat extends WeekDay
+      /** @inheritanceDiagram */
+      object Sun extends WeekDay
+    }
+  }
+}
\ No newline at end of file
diff --git a/test/scaladoc/run/SI-3314-diagrams.check b/test/scaladoc/run/SI-3314-diagrams.check
new file mode 100644
index 0000000000..619c56180b
--- /dev/null
+++ b/test/scaladoc/run/SI-3314-diagrams.check
@@ -0,0 +1 @@
+Done.
diff --git a/test/scaladoc/run/SI-3314-diagrams.scala b/test/scaladoc/run/SI-3314-diagrams.scala
new file mode 100644
index 0000000000..0b07e4c5bd
--- /dev/null
+++ b/test/scaladoc/run/SI-3314-diagrams.scala
@@ -0,0 +1,37 @@
+import scala.tools.nsc.doc.model._
+import scala.tools.nsc.doc.model.diagram._
+import scala.tools.partest.ScaladocModelTest
+
+object Test extends ScaladocModelTest {
+
+  override def resourceFile = "SI-3314-diagrams.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._
+
+    // 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 diagrams = base._package("diagrams")
+    def testDiagram(doc: DocTemplateEntity, diag: Option[Diagram], nodes: Int, edges: Int) = {
+      assert(diag.isDefined, doc.qualifiedName + " diagram missing")
+      assert(diag.get.nodes.length == nodes,
+             doc.qualifiedName + "'s diagram: node count " + diag.get.nodes.length + " == " + nodes)
+      assert(diag.get.edges.length == edges,
+             doc.qualifiedName + "'s diagram: edge count " + diag.get.edges.length + " == " + edges)
+    }
+
+    val templates = List(diagrams._trait("WeekDayTraitWithDiagram"), diagrams._class("WeekDayClassWithDiagram"), diagrams._object("WeekDayObjectWithDiagram"))
+
+    for (template <- templates) {
+      testDiagram(template, template.contentDiagram, 8, 7)
+      val subtemplates = List("Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun").map(template._object(_))
+      for (subtemplate <- subtemplates)
+        testDiagram(subtemplate, subtemplate.inheritanceDiagram, 2, 1)
+    }
+  }
+}
\ No newline at end of file
diff --git a/test/scaladoc/run/diagrams-base.scala b/test/scaladoc/run/diagrams-base.scala
index 38bed06502..b7aeed51d2 100644
--- a/test/scaladoc/run/diagrams-base.scala
+++ b/test/scaladoc/run/diagrams-base.scala
@@ -42,7 +42,7 @@ object Test extends ScaladocModelTest {
     assert(diag.nodes.filter(_.isThisNode).length == 1)
 
     // 1. check class E diagram
-    assert(diag.isClassDiagram)
+    assert(diag.isInheritanceDiagram)
 
     val (incoming, outgoing) = diag.edges.partition(!_._1.isThisNode)
     assert(incoming.length == 5)
@@ -56,14 +56,14 @@ object Test extends ScaladocModelTest {
     assert(incomingSubclass.length == 2)
     assert(incomingImplicit.length == 3)
 
-    val classDiag = diag.asInstanceOf[ClassDiagram]
+    val classDiag = diag.asInstanceOf[InheritanceDiagram]
     assert(classDiag.incomingImplicits.length == 3)
     assert(classDiag.outgoingImplicits.length == 1)
 
     // 2. check package diagram
     // NOTE: Z should be eliminated because it's isolated
     val packDiag = base.contentDiagram.get
-    assert(packDiag.isPackageDiagram)
+    assert(packDiag.isContentDiagram)
     assert(packDiag.nodes.length == 8) // check singular object removal
     assert(packDiag.edges.length == 4)
     assert(packDiag.edges.foldLeft(0)(_ + _._2.length) == 6)