Fix deprecation for java.lang.Deprecated

Author: BarkingBad

scala3doc-testcases/src/tests/deprecated.scala

@@ -1,5 +1,5 @@
 package tests
-package deprecated 
+package deprecated
 
 class A:
   def defInt: Int = 1
@@ -17,3 +17,7 @@ class B extends A:
   @deprecated(since = "1", message = "some reason")
   def x: Int = 1
   val y: Int = 1
+
+
+@java.lang.Deprecated(since = "1.1")
+class JavaDeprecated

scala3doc/src/dotty/dokka/model/api/api.scala

@@ -162,7 +162,7 @@ extension[T] (member: Member)
 
   def signature: Signature = memberExt.fold(Signature(name))(_.signature)
   def asLink: LinkToType = LinkToType(signature, dri, kind)
-  def deprecated: Option[Annotation] = memberExt.flatMap(_.annotations.find(a => a.dri.getPackageName == "scala" && a.dri.getClassNames == "deprecated"))
+  def deprecated: Option[Annotation] = memberExt.fold(None)(_.deprecated)
 
   def modifiers: Seq[dotty.dokka.model.api.Modifier] = memberExt.fold(Nil)(_.modifiers)
   def kind: Kind = memberExt.fold(Kind.Unknown)(_.kind)

scala3doc/src/dotty/dokka/model/api/internalExtensions.scala

@@ -31,7 +31,8 @@ case class MemberExtension(
   origin: Origin = Origin.RegularlyDefined,
   inheritedFrom: Option[InheritedFrom] = None,
   graph: HierarchyGraph = HierarchyGraph.empty,
-  rawDoc: Option[Comment] = None
+  rawDoc: Option[Comment] = None,
+  deprecated: Option[Annotation] = None
 ) extends ExtraProperty[Documentable]:
  override def getKey = MemberExtension
 

scala3doc/src/dotty/dokka/model/scalaModel.scala

@@ -34,8 +34,7 @@ case class HtmlContentNode(
 class ScalaTagWrapper(root: DocTag, val name: String) extends TagWrapper(null):
   override def getRoot = root
 
-object ScalaTagWrapper {
-
+object ScalaTagWrapper:
   case class See(root: DocTag) extends ScalaTagWrapper(root, "See")
   case class Todo(root: DocTag) extends ScalaTagWrapper(root, "Todo")
   case class Note(root: DocTag) extends ScalaTagWrapper(root, "Note")
@@ -48,11 +47,9 @@ object ScalaTagWrapper {
   ) extends NamedTagWrapper(null):
     override def getName = name
     override def getRoot = descTag
-}
 
 case class ImplicitConversion(conversion: Documentable, from: DRI, to: DRI)
 
-
 case class ContentNodeParams(
   val dci: DCI,
   val sourceSets: java.util.Set[DisplaySourceSet],
@@ -74,45 +71,6 @@ abstract class ScalaContentNode(params: ContentNodeParams) extends ContentNode:
   override def getExtra = params.extra
   override def withNewExtras(p: PropertyContainer[ContentNode]) = newInstance(params.copy(extra = p))
 
-case class DocumentableNameWithStyles(
-  name: String,
-  styles: Set[Style] = Set.empty,
-)
-
-case class DocumentableElement(
-  annotations: Signature,
-  modifiers: Signature,
-  nameWithStyles: DocumentableNameWithStyles,
-  signature: Signature,
-  brief: Seq[ContentNode],
-  originInfo: Signature,
-  attributes: Map[String, String],
-  params: ContentNodeParams,
-  member: Member
-) extends ScalaContentNode(params):
-  override def newInstance(params: ContentNodeParams) = copy(params = params)
-
-case class DocumentableElementGroup(
-  header: Signature,
-  elements: Seq[DocumentableElement],
-  params: ContentNodeParams
-) extends ScalaContentNode(params):
-  override def newInstance(params: ContentNodeParams) = copy(params = params)
-  override def hasAnyContent = elements.nonEmpty
-  override def getChildren: JList[ContentNode] = elements.asJava
-
-case class DocumentableList(
-  groupName: Signature,
-  elements: Seq[DocumentableElement | DocumentableElementGroup],
-  params: ContentNodeParams
-) extends ScalaContentNode(params):
-  override def newInstance(params: ContentNodeParams) = copy(params = params)
-  override def hasAnyContent = elements.nonEmpty
-  override def getChildren: JList[ContentNode] = elements.asJava
-
-case class DocumentableFilter(params: ContentNodeParams) extends ScalaContentNode(params):
-  override def newInstance(params: ContentNodeParams) = copy(params = params)
-
 case class MemberInfo(member: Member, params: ContentNodeParams)
   extends ScalaContentNode(params):
-    override def newInstance(params: ContentNodeParams) = copy(params = params)
+    override def newInstance(params: ContentNodeParams) = copy(params = params)

scala3doc/src/dotty/dokka/tasty/BasicSupport.scala

@@ -45,6 +45,12 @@ trait BasicSupport:
     def getAnnotations(): List[Annotation] =
       sym.annotations.filterNot(_.symbol.packageName.startsWith("scala.annotation.internal")).map(parseAnnotation).reverse
 
+    def isDeprecated(): Option[Annotation] =
+      sym.annotations.find { a =>
+        a.symbol.packageName == "scala" && a.symbol.className.fold(false)(_ == "deprecated") ||
+        a.symbol.packageName == "java.lang" && a.symbol.className.fold(false)(_ == "Deprecated")
+      }.map(parseAnnotation)
+
     def isLeftAssoc: Boolean = !sym.name.endsWith(":")
 
 

scala3doc/src/dotty/dokka/tasty/ClassLikeSupport.scala

@@ -107,7 +107,8 @@ trait ClassLikeSupport:
           classDef.symbol.getAnnotations(),
           selfSiangture,
           classDef.symbol.source(using qctx),
-          graph = graph
+          graph = graph,
+          deprecated = classDef.symbol.isDeprecated()
         ),
         compositeExt
     )
@@ -375,7 +376,8 @@ trait ClassLikeSupport:
         methodSymbol.getAnnotations(),
         memberInfo.res.dokkaType.asSignature,
         methodSymbol.source(using qctx),
-        origin
+        origin,
+        deprecated = methodSymbol.isDeprecated()
       )
     )
 
@@ -430,8 +432,9 @@ trait ClassLikeSupport:
         Kind.Type(!isTreeAbstract(typeDef.rhs), typeDef.symbol.isOpaque, generics),
         typeDef.symbol.getAnnotations(),
         tpeTree.dokkaType.asSignature,
-        typeDef.symbol.source(using qctx)
-        )
+        typeDef.symbol.source(using qctx),
+        deprecated = typeDef.symbol.isDeprecated()
+      )
     )
 
   def parseValDef(c: ClassDef, valDef: ValDef): Member =
@@ -449,7 +452,8 @@ trait ClassLikeSupport:
           kind,
           valDef.symbol.getAnnotations(),
           memberInfo.res.dokkaType.asSignature,
-          valDef.symbol.source(using qctx)
+          valDef.symbol.source(using qctx),
+          deprecated = valDef.symbol.isDeprecated()
       )
     )
 

scala3doc/src/dotty/dokka/translators/ScalaSignatureUtils.scala

@@ -56,7 +56,11 @@ trait SignatureBuilder extends ScalaSignatureUtils {
 
     private def buildAnnotationParams(a: Annotation): SignatureBuilder =
       if !a.params.isEmpty then
-        list(a.params, "(", ")", ", "){ (bdr, param) => bdr.buildAnnotationParameter(param)}
+        val params = a.params.filterNot {
+          case Annotation.LinkParameter(_, _, text) => text == "_"
+          case _ => false
+        }
+        list(params, "(", ")", ", "){ (bdr, param) => bdr.buildAnnotationParameter(param)}
       else this
 
     private def addParameterName(txt: Option[String]): SignatureBuilder = txt match {

scala3doc/src/dotty/renderers/MemberRenderer.scala

@@ -92,15 +92,14 @@ class MemberRenderer(signatureRenderer: SignatureRenderer, buildNode: ContentNod
       case Annotation.UnresolvedParameter(_, value) => stripQuotes(value)
 
     val (named, unnamed) = a.params.partition(_.name.nonEmpty)
-    val message = named.find(_.name.get == "message").orElse(unnamed.headOption)
-    val since = named.find(_.name.get == "since").orElse(unnamed.drop(1).headOption)
-
-    val content =
-      since.fold(Nil)(since =>
-        Seq(code("[Since version ", parameter(since), "] ")) ++
-          message.fold(Nil)(m => Seq(parameter(m))) ++
-          m.docs.fold(Nil)(_.deprecated.toSeq.map(renderDocPart))
-      )
+    val message = named.find(_.name.get == "message")
+    val since = named.find(_.name.get == "since")
+
+    val content = Seq(
+      since.map(s => code("[Since version ", parameter(s), "] ")),
+      message.map(m => parameter(m)),
+      m.docs.map(_.deprecated.toSeq.map(renderDocPart)):_*
+    ).flatten
     Seq(dt("Deprecated"), dd(content:_*))
   }
 

scala3doc/test/dotty/dokka/SignatureTestCases.scala

@@ -8,7 +8,6 @@ class ObjectSignatures extends SignatureTest("objectSignatures", Seq("object"))
 
 class TraitSignatures extends SignatureTest("traitSignatures", Seq("trait"))
 
-
 // We do not support companion objects properly in tests
 class ClassSignatureTestSourceTest extends SignatureTest("classSignatureTestSource",
   SignatureTest.all diff Seq("val", "var", "object"))