Add table cells for deprecation params

Author: BarkingBad

scala3doc-testcases/src/tests/deprecated.scala

@@ -1,18 +1,19 @@
 package tests
 package deprecated 
 
-@Deprecated
 class A:
   def defInt: Int = 1
+  @deprecated(message = "1")
   def def1: 1 = 1
+  @deprecated
   val valInt: Int = 1
   val val1: 1 = 1
   var varInt: Int = 1
   var var1: 1 = 1
   class InnerA:
     val innerVal: Int = 1
 
-class B:
-  @Deprecated
+class B extends A:
+  @deprecated(since = "1", message = "some reason")
   def x: Int = 1
   val y: Int = 1

scala3doc/src/dotty/dokka/DottyDokkaPlugin.scala

@@ -125,12 +125,6 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
       .name("implicitMembersExtensionTransformer")
   )
 
-  val deprecatedTransfomer = extend(
-    _.extensionPoint(CoreExtensions.INSTANCE.getDocumentableTransformer)
-      .fromInstance(DeprecatedTransformer)
-      .name("deprecatedTransformer")
-  )
-
   val customDocumentationProvider = extend(
     _.extensionPoint(dokkaBase.getHtmlPreprocessors)
       .fromRecipe(c => SitePagesCreator(c.siteContext))

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

@@ -80,10 +80,12 @@ enum Origin:
 case class Annotation(val dri: DRI, val params: List[Annotation.AnnotationParameter])
 
 object Annotation:
-  sealed trait AnnotationParameter
-  case class PrimitiveParameter(val name: Option[String] = None, val value: String) extends AnnotationParameter
-  case class LinkParameter(val name: Option[String] = None, val dri: DRI, val value: String) extends AnnotationParameter
-  case class UnresolvedParameter(val name: Option[String] = None, val unresolvedText: String) extends AnnotationParameter
+  sealed trait AnnotationParameter {
+    val name: Option[String]
+  }
+  case class PrimitiveParameter(name: Option[String] = None, value: String) extends AnnotationParameter
+  case class LinkParameter(name: Option[String] = None, dri: DRI, value: String) extends AnnotationParameter
+  case class UnresolvedParameter(name: Option[String] = None, unresolvedText: String) extends AnnotationParameter
 
 // TODO (longterm) properly represent signatures
 case class Link(name: String, dri: DRI)
@@ -124,7 +126,7 @@ extension[T] (member: Member):
 
   def signature: Signature = memberExt.fold(Signature(name))(_.signature)
   def asLink: LinkToType = LinkToType(signature, dri, kind)
-  def isDeprecated: Boolean = memberExt.fold(false)(_.deprecated)
+  def deprecated: Option[Annotation] = memberExt.flatMap(_.annotations.find(a => a.dri.getPackageName == "scala" && a.dri.getClassNames == "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

@@ -29,7 +29,6 @@ private [model] case class MemberExtension(
   sources: Option[TastyDocumentableSource] = None,
   origin: Origin = Origin.DefinedWithin,
   graph: HierarchyGraph = HierarchyGraph.empty,
-  deprecated: Boolean = false, // directly or indirectly
 ) extends ExtraProperty[Documentable]:
  override def getKey = MemberExtension
 
@@ -72,10 +71,6 @@ extension (member: Member):
     val ext = MemberExtension.getFrom(member).getOrElse(MemberExtension.empty).copy(kind = kind)
     putInMember(ext)
 
-  def withDeprecated(deprecated: Boolean): Member =
-    val ext = MemberExtension.getFrom(member).getOrElse(MemberExtension.empty).copy(deprecated = deprecated)
-    putInMember(ext)
-  
   def withMembers(newMembers: Seq[Member]): Member =
     val original = member.compositeMemberExt.getOrElse(CompositeMemberExtension())
     val newExt = original.copy(members = newMembers)

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

@@ -22,10 +22,13 @@ trait BasicSupport:
             case s: String => "\"" + s"$s" + "\""
             case other => other.toString()
           })
-          case Select(qual, name) =>
+          case NamedArg(name, Literal(constant)) => Annotation.PrimitiveParameter(Some(name), constant.value match
+            case s: String => "\"" + s"$s" + "\""
+            case other => other.toString()
+          )
+          case x @ Select(qual, name) =>
             val dri = qual.tpe.termSymbol.companionClass.dri
             Annotation.LinkParameter(None, dri, s"${dri.getClassNames}.$name") // TODO this is a nasty hack!
-
           case other => Annotation.UnresolvedParameter(None, other.show)
         }
       }

scala3doc/src/dotty/dokka/transformers/DeprecatedTransformer.scala

@@ -496,7 +496,7 @@ class ScalaPageContentBuilder(
             Signature("Exported from ", signatureName)
           case _ => Nil
         }
-        val styles: Set[Style] = if documentable.isDeprecated then Set(TextStyle.Strikethrough) else Set.empty
+        val styles: Set[Style] = if documentable.deprecated.isDefined then Set(TextStyle.Strikethrough) else Set.empty
         DocumentableElement(
           buildAnnotations(documentable),
           signatureBuilder.preName.reverse,

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

@@ -323,14 +323,34 @@ class ScalaPageCreator(
             case _ => withCompanion
           }
 
-          d match
+          val withSource = d match
             case null => withExtensionInformation
             case m: Member =>
               sourceLinks.pathTo(m).fold(withCompanion){ link =>
                 val sourceSets = m.getSourceSets.asScala.toSet
                 withExtensionInformation.cell(sourceSets = sourceSets)(_.text("Source"))
                   .cell(sourceSets = sourceSets)(_.resolvedLink("(source)", link))
+
               }
+
+          d.deprecated match
+            case None => withSource
+            case Some(a) => 
+              extension (b: ScalaPageContentBuilder#ScalaDocumentableContentBuilder) 
+                def annotationParameter(p: Option[Annotation.AnnotationParameter]): ScalaPageContentBuilder#ScalaDocumentableContentBuilder =
+                  p match
+                    case Some(Annotation.PrimitiveParameter(_, value)) => b.text(value.stripPrefix("\"").stripSuffix("\""))
+                    case Some(Annotation.LinkParameter(_, dri, text)) => b.driLink(text.stripPrefix("\"").stripSuffix("\""), dri)
+                    case Some(Annotation.UnresolvedParameter(_, value)) => b.text(value.stripPrefix("\"").stripSuffix("\""))
+                    case _ => b
+              val since = a.params.find(_.name.contains("since"))
+              val message = a.params.find(_.name.contains("message"))
+              val sourceSets = d.getSourceSets.asScala.toSet
+              withSource.cell(sourceSets = sourceSets)(_.text("Deprecated"))
+                .cell(sourceSets = sourceSets) { b =>
+                  val withPossibleSince = if (since.isDefined) b.text("(Since version ").annotationParameter(since).text(") ") else b
+                  withPossibleSince.annotationParameter(message)
+                }
         }
       }
     }

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

@@ -45,7 +45,7 @@ class ScalaSignatureProvider(contentConverter: CommentsToContentConverter, logge
     })
 
   private def stylesIfDeprecated(m: Member): Set[Style] =
-    if m.isDeprecated then styles ++ Set(TextStyle.Strikethrough) else styles
+    if m.deprecated.isDefined then styles ++ Set(TextStyle.Strikethrough) else styles
 
 
 object ScalaSignatureProvider:

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

@@ -55,7 +55,7 @@ trait SignatureBuilder extends ScalaSignatureUtils {
       else this
 
     private def addParameterName(txt: Option[String]): SignatureBuilder = txt match {
-        case Some(name) => this.text(s"$txt = ")
+        case Some(name) => this.text(s"$name = ")
         case _ => this
       }