Merge pull request #110 from manuzhang/translate_tparam

Support translating @tparam to @param

Author: ktoso

plugin/src/main/scala/com/typesafe/genjavadoc/Output.scala

@@ -5,11 +5,20 @@ import java.io.File
 
 trait Output { this: TransformCake ⇒
 
+  private val Tparam = "(.*@tparam )(\\S+)( .*)".r
+
   def outputBase: File
 
   def write(out: Out, c: ClassInfo) {
     // TODO @param should be transformed to constructor comments
-    c.comment foreach (line => out(line.replace("@param", "param: ")))
+    c.comment foreach {line =>
+      val replaced = line.replace("@param", "param: ") match {
+          case Tparam(_, param, desc) ⇒
+            s" * @param <$param> $desc"
+          case x ⇒ x
+        }
+      out(replaced)
+    }
     out(s"${c.sig} {")
     out.indent()
     for (m ← c.members)

plugin/src/test/resources/expected_output/basic/akka/rk/buh/is/it/Y.java

@@ -1,3 +1,6 @@
 package akka.rk.buh.is.it;
+/**
+ * @param <A> I am a type parameter description
+ */
 public  interface Y<A extends java.lang.Object> {
 }

plugin/src/test/resources/input/basic/test.scala

@@ -8,6 +8,9 @@ package buh.is.it
 import scala.annotation.varargs
 import scala.concurrent.duration.FiniteDuration
 
+/**
+ * @tparam A I am a type parameter description
+ */
 trait Y[A] {
   // def pi = 3.14
 }