Add support for experimental (separate section)

Author: szymon-rd

scaladoc/src/dotty/tools/scaladoc/api.scala

@@ -172,6 +172,7 @@ case class Member(
   knownChildren: Seq[LinkToType] = Nil,
   companion: Option[(Kind, DRI)] = None,
   deprecated: Option[Annotation] = None,
+  experimental: Option[Annotation] = None
 ):
   def needsOwnPage: Boolean =
     def properKind(kind: Kind): Boolean = kind match

scaladoc/src/dotty/tools/scaladoc/renderers/MemberRenderer.scala

@@ -98,6 +98,8 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
     tableRow("Deprecated", content*)
   }
 
+  def experimental(m: Member) = m.experimental.fold(Nil)(_ => tableRow("Experimental", Seq("true")))
+
   def typeParams(m: Member): Seq[AppliedTag] = m.docs.fold(Nil)(d => flattenedDocPart(d.typeParams))
   def valueParams(m: Member): Seq[AppliedTag] = m.docs.fold(Nil)(d => flattenedDocPart(d.valueParams))
 
@@ -113,6 +115,7 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
       docAttributes(m),
       companion(m),
       deprecation(m),
+      experimental(m),
       defintionClasses(m),
       inheritedFrom(m),
       source(m),
@@ -304,6 +307,10 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
     case m: Member => m.deprecated.nonEmpty
     case g: MGroup => g.members.exists(isDeprecated)
 
+  private def isExperimental(m: Member | MGroup): Boolean = m match
+    case m: Member => m.experimental.nonEmpty
+    case g: MGroup => g.members.exists(isExperimental)
+
   private def isInherited(m: Member | MGroup): Boolean = m match
     case m: Member => m.inheritedFrom.nonEmpty
     case g: MGroup => g.members.exists(isInherited)
@@ -315,7 +322,8 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
   private type SubGroup = (String, Seq[Member | MGroup])
   private def buildGroup(name: String, subgroups: Seq[SubGroup]): Tab =
     val all = subgroups.map { case (name, members) =>
-      val (allInherited, allDefined) = members.partition(isInherited)
+      val (experimental, nonExperimental) = members.partition(isExperimental)
+      val (allInherited, allDefined) = nonExperimental.partition(isInherited)
       val (depDefined, defined) = allDefined.partition(isDeprecated)
       val (depInherited, inherited) = allInherited.partition(isDeprecated)
       val normalizedName = name.toLowerCase
@@ -331,7 +339,8 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
       definedWithGroup ++ List(
         actualGroup(s"Deprecated ${normalizedName}", depDefined),
         actualGroup(s"Inherited ${normalizedName}", inherited),
-        actualGroup(s"Deprecated and Inherited ${normalizedName}", depInherited)
+        actualGroup(s"Deprecated and Inherited ${normalizedName}", depInherited),
+        actualGroup(name = s"Experimental ${normalizedName}", experimental)
       )
     }
 

scaladoc/src/dotty/tools/scaladoc/tasty/BasicSupport.scala

@@ -66,5 +66,10 @@ trait BasicSupport:
         a.symbol.packageName == "java.lang" && a.symbol.className.contains("Deprecated")
       }.map(parseAnnotation)
 
+    def isExperimental(): Option[Annotation] =
+      sym.annotations.find { a =>
+        a.symbol.packageName == "scala.annotation" && a.symbol.className.contains("experimental")
+      }.map(parseAnnotation)
+
     def isLeftAssoc: Boolean = !sym.name.endsWith(":")
   end extension

scaladoc/src/dotty/tools/scaladoc/tasty/ClassLikeSupport.scala

@@ -110,6 +110,7 @@ trait ClassLikeSupport:
       modifiers = modifiers,
       graph = graph,
       deprecated = classDef.symbol.isDeprecated(),
+      experimental = classDef.symbol.isExperimental()
     ).copy(
       directParents = classDef.getParentsAsLinkToTypes,
       parents = supertypes,
@@ -382,7 +383,16 @@ trait ClassLikeSupport:
         .filterNot(m => m == Modifier.Lazy || m == Modifier.Final)
       case _ => methodSymbol.getExtraModifiers()
 
-    mkMember(methodSymbol, methodKind, method.returnTpt.tpe.asSignature)(modifiers = modifiers, origin = origin, deprecated = methodSymbol.isDeprecated())
+    mkMember(
+      methodSymbol,
+      methodKind,
+      method.returnTpt.tpe.asSignature
+    )(
+      modifiers = modifiers,
+      origin = origin,
+      deprecated = methodSymbol.isDeprecated(),
+      experimental = methodSymbol.isExperimental()
+    )
 
   def mkParameter(
     argument: ValDef,
@@ -450,7 +460,11 @@ trait ClassLikeSupport:
           Some(Link(l.tpe.typeSymbol.owner.name, l.tpe.typeSymbol.owner.dri))
         case _ => None
       }
-      mkMember(typeDef.symbol, Kind.Exported(kind), tpeTree.asSignature)(deprecated = typeDef.symbol.isDeprecated(), origin = Origin.ExportedFrom(origin))
+      mkMember(typeDef.symbol, Kind.Exported(kind), tpeTree.asSignature)(
+        deprecated = typeDef.symbol.isDeprecated(),
+        origin = Origin.ExportedFrom(origin),
+        experimental = typeDef.symbol.isExperimental()
+      )
     }
     else mkMember(typeDef.symbol, kind, tpeTree.asSignature)(deprecated = typeDef.symbol.isDeprecated())
 
@@ -468,14 +482,19 @@ trait ClassLikeSupport:
         .filterNot(m => m == Modifier.Lazy || m == Modifier.Final)
       case _ => valDef.symbol.getExtraModifiers()
 
-    mkMember(valDef.symbol, kind, memberInfo.res.asSignature)(modifiers = modifiers, deprecated = valDef.symbol.isDeprecated())
+    mkMember(valDef.symbol, kind, memberInfo.res.asSignature)(
+      modifiers = modifiers,
+      deprecated = valDef.symbol.isDeprecated(),
+      experimental = valDef.symbol.isExperimental()
+    )
 
   def mkMember(symbol: Symbol, kind: Kind, signature: DSignature)(
     modifiers: Seq[Modifier] = symbol.getExtraModifiers(),
     origin: Origin = Origin.RegularlyDefined,
     inheritedFrom: Option[InheritedFrom] = None,
     graph: HierarchyGraph = HierarchyGraph.empty,
     deprecated: Option[Annotation] = None,
+    experimental: Option[Annotation] = None
   ) = Member(
     name = symbol.normalizedName,
     fullName = symbol.fullName,
@@ -490,7 +509,8 @@ trait ClassLikeSupport:
     inheritedFrom = inheritedFrom,
     graph = graph,
     docs = symbol.documentation,
-    deprecated = deprecated
+    deprecated = deprecated,
+    experimental = experimental
   )
 
   object EvidenceOnlyParameterList