From 293f7c007e1cfdfe67a61a02f8d9eee0bc4fcc87 Mon Sep 17 00:00:00 2001
From: Antoine Gourlay <antoine@gourlay.fr>
Date: Thu, 2 Apr 2015 17:15:57 +0200
Subject: SI-5795 empty scaladoc tags should be omitted from output

Empty scaladoc tags, like `@param`, `@return`, `@version`, etc. should
be omitted from the output when they have no meaning by themselves.

They are still parsed, for validation (warning that a tag doesn't
exist and so on), but are removed, if empty, when building the Comment.

The only ones that stay even when empty are `@deprecated`, so that the
class name can be striked-through ("Deprecated" also appears in the
header, even if there is no message with it), and `@throws`.
---
 test/scaladoc/run/t5795.check |  4 +++
 test/scaladoc/run/t5795.scala | 63 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 67 insertions(+)
 create mode 100644 test/scaladoc/run/t5795.check
 create mode 100644 test/scaladoc/run/t5795.scala

(limited to 'test')

diff --git a/test/scaladoc/run/t5795.check b/test/scaladoc/run/t5795.check
new file mode 100644
index 0000000000..d08ab619ed
--- /dev/null
+++ b/test/scaladoc/run/t5795.check
@@ -0,0 +1,4 @@
+newSource:16: warning: Could not find any member to link for "Exception".
+  /**
+  ^
+Done.
diff --git a/test/scaladoc/run/t5795.scala b/test/scaladoc/run/t5795.scala
new file mode 100644
index 0000000000..767e4f1a72
--- /dev/null
+++ b/test/scaladoc/run/t5795.scala
@@ -0,0 +1,63 @@
+import scala.tools.nsc.doc.model._
+import scala.tools.partest.ScaladocModelTest
+
+object Test extends ScaladocModelTest {
+
+  override def code = """
+/**
+  * Only the 'deprecated' tag should stay.
+  *
+  * @author
+  * @since
+  * @todo
+  * @note
+  * @see
+  * @version
+  * @deprecated
+  * @example
+  * @constructor
+  */
+object Test {
+  /**
+    * Only the 'throws' tag should stay.
+    * @param foo
+    * @param bar
+    * @param baz
+    * @return
+    * @throws Exception
+    * @tparam T
+    */
+  def foo[T](foo: Any, bar: Any, baz: Any): Int = 1
+}
+  """
+
+  def scaladocSettings = ""
+
+  def test(b: Boolean, text: => String): Unit = if (!b) println(text)
+
+  def testModel(root: Package) = {
+    import access._
+    val obj = root._object("Test")
+    val c = obj.comment.get
+
+    test(c.authors.isEmpty, s"expected no authors, found: ${c.authors}")
+    test(!c.since.isDefined, s"expected no since tag, found: ${c.since}")
+    test(c.todo.isEmpty, s"expected no todos, found: ${c.todo}")
+    test(c.note.isEmpty, s"expected no note, found: ${c.note}")
+    test(c.see.isEmpty, s"expected no see, found: ${c.see}")
+    test(!c.version.isDefined, s"expected no version tag, found: ${c.version}")
+    // deprecated stays
+    test(c.deprecated.isDefined, s"expected deprecated tag, found none")
+    test(c.example.isEmpty, s"expected no example, found: ${c.example}")
+    test(!c.constructor.isDefined, s"expected no constructor tag, found: ${c.constructor}")
+
+    val method = obj._method("foo")
+    val mc = method.comment.get
+
+    test(mc.valueParams.isEmpty, s"expected empty value params, found: ${mc.valueParams}")
+    test(mc.typeParams.isEmpty, s"expected empty type params, found: ${mc.typeParams}")
+    test(!mc.result.isDefined, s"expected no result tag, found: ${mc.result}")
+    // throws stay
+    test(!mc.throws.isEmpty, s"expected an exception tag, found: ${mc.throws}")
+  }
+}
-- 
cgit v1.2.3