Handle deprecated signatures in Scala3doc

Author: BarkingBad

scala3doc-testcases/src/tests/deprecated.scala

@@ -0,0 +1,18 @@
+package tests
+package deprecated 
+
+@Deprecated
+class A:
+  def defInt: Int = 1
+  def def1: 1 = 1
+  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
+  def x: Int = 1
+  val y: Int = 1

scala3doc/resources/dotty_res/styles/scalastyle.css

@@ -292,6 +292,9 @@ th {
   padding-top: 0;
 }
 
+span[data-unresolved-link].strikethrough, a.strikethrough, div.strikethrough {
+  text-decoration: line-through;
+}
 .brief {
   white-space: pre-wrap;
   overflow: hidden;

scala3doc/src/dotty/dokka/DottyDokkaPlugin.scala

@@ -125,6 +125,12 @@ 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

@@ -124,6 +124,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 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

@@ -24,11 +24,12 @@ private [model] case class MemberExtension(
   visibility: Visibility,
   modifiers: Seq[dotty.dokka.model.api.Modifier],
   kind: Kind,
-  val annotations: List[Annotation],
+  annotations: List[Annotation],
   signature: Signature,
   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
 
@@ -71,6 +72,10 @@ 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/model/scalaModel.scala

@@ -88,10 +88,15 @@ 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,
-  name: String,
+  nameWithStyles: DocumentableNameWithStyles,
   signature: Signature,
   brief: Seq[ContentNode],
   originInfo: Signature,

scala3doc/src/dotty/dokka/site/PartiallyRenderedContent.scala

@@ -40,23 +40,3 @@ case class PartiallyRenderedContent(
       }
     }// forrach does not work here
     document.outerHtml()
-
-
-class A:
-  def defInt: Int = 1
-  def def1: 1 = 1
-  val valInt: Int = 1
-  val val1: 1 = 1
-  var varInt: Int = 1
-  var var1: 1 = 1
-
-object X:
-  def x: Int = 1
-  val x2: 1 = 1
-  var x3: Int = 1
-
-class B:
-  val a = new A
-  export a._
-  export X._
-

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

@@ -0,0 +1,27 @@
+package dotty.dokka
+
+import org.jetbrains.dokka.plugability.DokkaContext
+import org.jetbrains.dokka.transformers.documentation.DocumentableTransformer
+import org.jetbrains.dokka.model._
+import collection.JavaConverters
+import collection.JavaConverters._
+import org.jetbrains.dokka.plugability.DokkaContext
+import org.jetbrains.dokka.model.properties._
+import dotty.dokka.model.api.memberExt
+
+import dotty.dokka.model._
+import dotty.dokka.model.api._
+
+object DeprecatedTransformer extends DocumentableTransformer:
+
+  private def updateRecursively(member: Member, op: (Boolean, Member) => Member): Member = 
+    member.withMembers(member.allMembers.map { case m: Member => updateRecursively(op(member.isDeprecated, m), op) })
+  
+  override def invoke(original: DModule, context: DokkaContext): DModule =
+    def appendDeprecated(isParentDeprecated: Boolean, m: Member): Member =
+      m.withDeprecated(isParentDeprecated || !m.annotations.filter(a => a.dri.getPackageName == "java.lang" && a.dri.getClassNames == "Deprecated" ).isEmpty)
+  
+    original.updatePackages(_.map(p => updateRecursively(appendDeprecated(false, p), appendDeprecated).asInstanceOf[DPackage]))
+
+  
+    

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

@@ -496,11 +496,11 @@ class ScalaPageContentBuilder(
             Signature("Exported from ", signatureName)
           case _ => Nil
         }
-
+        val styles: Set[Style] = if documentable.isDeprecated then Set(TextStyle.Strikethrough) else Set.empty
         DocumentableElement(
           buildAnnotations(documentable),
           signatureBuilder.preName.reverse,
-          documentable.getName,
+          DocumentableNameWithStyles(documentable.getName, styles),
           signatureBuilder.names.reverse,
           docs.fold(Nil)(d => reset().rawComment(d.getRoot)),
           originInfo,

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

@@ -22,7 +22,9 @@ class ScalaSignatureProvider(contentConverter: CommentsToContentConverter, logge
 
   private def signatureContent(d: Documentable)(
     func: ScalaPageContentBuilder#ScalaDocumentableContentBuilder => ScalaPageContentBuilder#ScalaDocumentableContentBuilder
-  ) = contentBuilder.contentForDocumentable(d, kind = ContentKind.Symbol, styles = styles, buildBlock = func)
+  ) = 
+    val styles = stylesIfDeprecated(d)
+    contentBuilder.contentForDocumentable(d, kind = ContentKind.Symbol, styles = styles, buildBlock = func)
 
 
   case class ContentNodeBuilder(builder: ScalaPageContentBuilder#ScalaDocumentableContentBuilder) extends SignatureBuilder{
@@ -42,6 +44,10 @@ class ScalaSignatureProvider(contentConverter: CommentsToContentConverter, logge
       res.asInstanceOf[ContentNodeBuilder].builder
     })
 
+  private def stylesIfDeprecated(m: Member): Set[Style] =
+    if m.isDeprecated then styles ++ Set(TextStyle.Strikethrough) else styles
+    
+
 object ScalaSignatureProvider:
   def rawSignature(documentable: Documentable, builder: SignatureBuilder): SignatureBuilder =
     documentable match

scala3doc/src/dotty/renderers/ScalaHtmlRenderer.scala

@@ -85,7 +85,7 @@ class ScalaHtmlRenderer(ctx: DokkaContext, args: Args) extends HtmlRenderer(ctx)
   }
 
   override def wrapGroup(f: FlowContent, node: ContentGroup, pageContext: ContentPage, childrenCallback: FlowContentConsumer) = {
-    val additionalClasses = node.getStyle.asScala.map(_.toString.toLowerCase).mkString("", ",", "")
+    val additionalClasses = node.getStyle.asScala.map(_.toString.toLowerCase).mkString("", " ", "")
     def buildSymbol: String = div(cls := s"symbol $additionalClasses")(
       raw(
         buildWithKotlinx(childrenCallback).toString
@@ -134,7 +134,7 @@ class ScalaHtmlRenderer(ctx: DokkaContext, args: Args) extends HtmlRenderer(ctx)
             span(cls := "other-modifiers")(otherModifiers.map(renderElement)),
             span(cls := "kind")(kind.map(renderElement)),
           ),
-          renderLink(element.name, element.params.dri, cls := "documentableName monospace"),
+          renderLink(element.nameWithStyles.name, element.params.dri, cls := s"documentableName monospace ${element.nameWithStyles.styles.map(_.toString.toLowerCase).mkString(" ")}"),
           span(cls := "signature monospace")(element.signature.map(renderElement)),
           div(
             div(cls := "originInfo")(element.originInfo.map(renderElement)),

scala3doc/test/dotty/dokka/SignatureTest.scala

@@ -103,7 +103,7 @@ abstract class SignatureTest(
       case c: ContentComposite =>
           c.getChildren.asScala.flatMap(flattenToText).toSeq
       case l: DocumentableElement =>
-          (l.annotations ++ Seq(" ") ++ l.modifiers ++ Seq(l.name) ++ l.signature).map {
+          (l.annotations ++ Seq(" ") ++ l.modifiers ++ Seq(l.nameWithStyles.name) ++ l.signature).map {
               case s: String => s
               case Link(s: String, _) => s
           }