From 6b9f5437e84b4bbb021dba6af58851ba54c3c0b7 Mon Sep 17 00:00:00 2001
From: Antoine Gourlay <antoine@gourlay.fr>
Date: Tue, 4 Nov 2014 14:28:48 +0100
Subject: SI-5730 hide constructors of sealed abstract classes in scaladoc

Sealed abstract classes (like `List`) have a primary constructor, public
by default. It can never be called by external code but it shows up in
the scaladoc as a nice `new List()` construtor...

If a class is only abstract, the constructor is still useful because
people can subclass and call it. If it is only sealed (i.e. effectively final),
then it is the normal constructor of a final class. But sealed *and*
abstract makes documenting the constructor useless.

This should remove the misleading constructors of `List`, `Double`,
`Option` and others from the scaladoc.
---
 test/scaladoc/run/t5730.check |  1 +
 test/scaladoc/run/t5730.scala | 36 ++++++++++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+)
 create mode 100644 test/scaladoc/run/t5730.check
 create mode 100644 test/scaladoc/run/t5730.scala

(limited to 'test/scaladoc')

diff --git a/test/scaladoc/run/t5730.check b/test/scaladoc/run/t5730.check
new file mode 100644
index 0000000000..619c56180b
--- /dev/null
+++ b/test/scaladoc/run/t5730.check
@@ -0,0 +1 @@
+Done.
diff --git a/test/scaladoc/run/t5730.scala b/test/scaladoc/run/t5730.scala
new file mode 100644
index 0000000000..cc4c2444b1
--- /dev/null
+++ b/test/scaladoc/run/t5730.scala
@@ -0,0 +1,36 @@
+import scala.tools.nsc.doc.base._
+import scala.tools.nsc.doc.model._
+import scala.tools.partest.ScaladocModelTest
+
+object Test extends ScaladocModelTest {
+
+  override def code = """
+      package scala.test.scaladoc.T5730
+
+      /**
+       *  A link:
+       *
+       * [[scala.Option$ object Option]].
+       */
+      sealed abstract class A
+
+      case object B extends A
+
+      abstract final class C
+      """
+
+  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._
+
+    val p = rootPackage._package("scala")._package("test")._package("scaladoc")._package("T5730")
+
+    val a = p._class("A")
+    val c = p._class("C")
+
+    assert(a.constructors.isEmpty, s"there should be no constructors, found: ${a.constructors}")
+    assert(c.constructors.isEmpty, s"there should be no constructors, found: ${c.constructors}")
+  }
+}
-- 
cgit v1.2.3