Support java Deprecated on Scala symbols

lightbend · Mar 4, 2024 · a802823 · a802823
1 parent 2023c30
commit a802823
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 5 deletions.
diff --git a/src/main/scala/com/typesafe/genjavadoc/AST.scala b/src/main/scala/com/typesafe/genjavadoc/AST.scala
@@ -96,9 +96,11 @@ trait AST { this: TransformCake =>
   def fabricateParams: Boolean
 
   case class DeprecationInfo(msg: String, since: String) {
-    def maybeDot = if (msg.endsWith(".")) " " else ". "
-    def maybeSinceDot = if (since.endsWith(".")) " " else ". "
-    def render = s" * @deprecated ${msg}${maybeDot}Since $since${maybeSinceDot}"
+    def render = {
+      val rMsg = if (msg.isEmpty) "" else s" ${msg.stripSuffix(".")}."
+      val rSince = if (since.isEmpty) "" else s" Since ${since.stripSuffix(".")}."
+      s" * @deprecated$rMsg$rSince"
+    }
 
     def appendToComment(comment: Seq[String]): Seq[String] = comment.toVector match {
       case init :+ " */" =>

diff --git a/src/main/scala/com/typesafe/genjavadoc/BasicTransform.scala b/src/main/scala/com/typesafe/genjavadoc/BasicTransform.scala
@@ -160,8 +160,9 @@ trait BasicTransform { this: TransformCake =>
   private def deprecationInfo(d: ImplDef): Option[DeprecationInfo] = deprecationInfo(d.symbol)
   private def deprecationInfo(symbol: Symbol): Option[DeprecationInfo] =
     if (symbol.isDeprecated) {
-      val deprec = symbol.getAnnotation(definitions.DeprecatedAttr).get
-      Some(DeprecationInfo(deprec.stringArg(0).getOrElse(""), deprec.stringArg(1).getOrElse("")))
+      // symbol either has `DeprecatedAttr` or `JavaDeprecatedAttr`
+      val deprec = symbol.getAnnotation(definitions.DeprecatedAttr)
+      Some(DeprecationInfo(deprec.flatMap(_.stringArg(0)).getOrElse(""), deprec.flatMap(_.stringArg(1)).getOrElse("")))
     } else None
 
 }
diff --git a/src/test/resources/expected_output/basic/akka/rk/buh/is/it/DontTouchThis.java b/src/test/resources/expected_output/basic/akka/rk/buh/is/it/DontTouchThis.java
@@ -10,6 +10,12 @@ public class DontTouchThis {
    * @deprecated This is already deprecated. Since now.
    */
   public void alreadyDeprecatedInComment () { throw new RuntimeException(); }
+  /**
+   * buh!
+   *
+   * @deprecated
+   */
+  public void javaDeprecatedThingie () { throw new RuntimeException(); }
   /**
    * Some methods are forever.
    *

diff --git a/src/test/resources/input/basic/test.scala b/src/test/resources/input/basic/test.scala
@@ -275,6 +275,12 @@ private[it] class DontTouchThis {
    */
   @deprecated("This will be ignored", since = "ever")
   def alreadyDeprecatedInComment = ()
+
+  /**
+   * buh!
+   */
+  @Deprecated
+  def javaDeprecatedThingie = ()
 }
 
 @deprecated("Les Scalac Voyages Extraordinaire", since = "now")