Add companion icons. Add fqname, companion badge. Style main signature

Author: pikinier20

scaladoc/resources/dotty_res/styles/theme/components/navigation-item.css

@@ -107,7 +107,7 @@
   color: var(--action-primary-content-selected);
 }
 
-.micon {
+nav .micon {
   box-sizing: content-box;
   margin-right: calc(1 * var(--base-spacing));
   color: transparent;

scaladoc/resources/dotty_res/styles/theme/layout/content.css

@@ -60,6 +60,8 @@
 #content h1,
 #content h2 {
   color: var(--text-primary);
+  margin-block-end: 0;
+  margin-block-start: 0;
 }
 
 /* content paragraph */
@@ -208,8 +210,45 @@
 
 .cover-header {
   display: flex;
+  align-items: center;
 }
 
 .cover-header .micon {
-  margin-right: calc(2 * var(--base-spacing));
+  position: relative;
+  z-index: 10;
+}
+
+.cover-header .micon.companion {
+  position: relative;
+  left: -16px;
+  z-index: 0;
+}
+
+.cover-header .icon {
+  width: 72px;
+}
+
+.fqname {
+  color: var(--text-secondary);
+}
+
+.companion-badge {
+  color: var(--text-primary);
+  padding: 16px;
+  background-color: var(--indigo3);
+}
+
+.companion-badge .micon {
+  margin-left: 0.5em;
+  margin-right: 0.5em;
+}
+
+.main-signature {
+  background-color: var(--action-primary-background-default-solid);
+  padding: 24px;
+  border-radius: 4px;
+}
+
+#content>div>* {
+  margin-bottom: 24px;
 }

scaladoc/src/dotty/tools/scaladoc/ScalaModuleProvider.scala

@@ -16,7 +16,7 @@ object ScalaModuleProvider:
     def flattenMember(m: Member): Seq[(DRI, Member)] = (m.dri -> m) +: m.members.flatMap(flattenMember)
 
     val topLevelPackage =
-      Member("API", site.apiPageDRI, Kind.RootPackage, members = packageMembers, docs = rootDoc)
+      Member("API", "", site.apiPageDRI, Kind.RootPackage, members = packageMembers, docs = rootDoc)
 
     val original = Module(topLevelPackage, flattenMember(topLevelPackage).toMap)
 

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

@@ -153,6 +153,7 @@ object HierarchyGraph:
 
 case class Member(
   name: String,
+  fullName: String,
   dri: DRI,
   kind: Kind,
   visibility: Visibility = Visibility.Unrestricted,
@@ -169,7 +170,7 @@ case class Member(
   parents: Seq[LinkToType] = Nil,
   selfType: Option[LinkToType] = None,
   knownChildren: Seq[LinkToType] = Nil,
-  companion: Option[DRI] = None,
+  companion: Option[(Kind, DRI)] = None,
   deprecated: Option[Annotation] = None,
 ):
   def needsOwnPage: Boolean =

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

@@ -67,7 +67,7 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
       list("Example:", d.example)
     )
 
-  def companion(m: Member): Seq[AppliedTag] = m.companion.fold(Nil){dri =>
+  def companion(m: Member): Seq[AppliedTag] = m.companion.fold(Nil){ (_, dri) =>
     val kindName = if m.kind == Kind.Object then "class" else "object"
     tableRow("Companion:", signatureRenderer.renderLink(kindName, dri))
   }
@@ -152,9 +152,13 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
 
   def memberIcon(member: Member) = member.kind match {
     case _ =>
-      val withCompanion = member.companion.fold("")(_ => "-wc")
-      val iconSpan = span(cls := s"micon ${member.kind.name.take(2)}$withCompanion")()
-      Seq(member.companion.flatMap(link(_)).fold(iconSpan)(link => a(href := link)(iconSpan)))
+
+      // val iconSpan = span(cls := s"micon ${member.kind.name.take(2)}$withCompanion")()
+      val iconSpan = span(cls := "icon")(
+        span(cls := s"micon ${member.kind.name.take(2)}"),
+        member.companion.map((kind, _) => span(cls := s"micon companion ${kind.name.take(2)}")).toList
+      )
+      Seq(member.companion.flatMap( (_, dri) => link(dri)).fold(iconSpan)(link => a(href := link)(iconSpan)))
   }
 
   def annotations(member: Member) =
@@ -389,6 +393,18 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
     button(cls := "clearButton label-only-button",  testId := "filterBarClearButton")("Clear all"),
   )
 
+  private def companionBadge(m: Member): Seq[AppliedTag] = m.companion.fold(Nil) { companion =>
+    Seq(div(cls := "companion-badge body-small")(
+      span(
+        "See the",
+        span(cls := s"micon ${companion._1.name.take(2)}"),
+        a(href := link(companion._2).getOrElse(""))(m.name),
+        " companion ",
+        companion._1.name
+      )
+    ))
+  }
+
   def fullMember(m: Member): PageContent =
     val intro = m.kind match
       case Kind.RootPackage =>Seq(h1(summon[DocContext].args.name))
@@ -398,7 +414,12 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext
             memberIcon(m),
             h1(cls := "h600")(m.name)
           ),
-          div(cls := "signature monospace")(
+          div(cls := "fqname body-large")(
+            span(m.fullName)
+          )
+        ) ++ companionBadge(m) ++
+        Seq(
+          div(cls := "main-signature mono-medium")(
             annotations(m),
             memberSignature(m)
           )

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

@@ -286,10 +286,10 @@ trait ClassLikeSupport:
     def getTypeParams: List[TypeDef] =
       c.body.collect { case targ: TypeDef => targ  }.filter(_.symbol.isTypeParam)
 
-    def getCompanion: Option[DRI] = c.symbol.getCompanionSymbol
+    def getCompanion: Option[(Kind, DRI)] = c.symbol.getCompanionSymbol
       .filter(!_.flags.is(Flags.Synthetic))
       .filterNot(_.isHiddenByVisibility)
-      .map(_.dri)
+      .map(s => (bareClasslikeKind(s), s.dri))
 
 
   def parseClasslike(classDef: ClassDef, signatureOnly: Boolean = false): Member = classDef match
@@ -466,6 +466,7 @@ trait ClassLikeSupport:
     deprecated: Option[Annotation] = None,
   ) = Member(
     name = symbol.normalizedName,
+    fullName = symbol.fullName,
     dri = symbol.dri,
     kind = kind,
     visibility = symbol.getVisibility(),

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

@@ -13,7 +13,7 @@ trait PackageSupport:
 
     def parsePackage(pck: PackageClause): (String, Member) =
       val name = pck.symbol.fullName
-      (name, Member(name, pck.symbol.dri, Kind.Package))
+      (name, Member(name, "", pck.symbol.dri, Kind.Package))
 
     def parsePackageObject(pckObj: ClassDef): (String, Member) =
       pckObj.symbol.packageName -> parseClasslike(pckObj).withKind(Kind.Package)

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

@@ -135,7 +135,7 @@ case class ScaladocTastyInspector()(using ctx: DocContext) extends DocTastyInspe
       topLevels ++= intrinsicTypeDefs
       val scalaPckg = defn.ScalaPackage
       given parser.qctx.type = parser.qctx
-      topLevels += "scala" -> Member(scalaPckg.fullName, scalaPckg.dri, Kind.Package)
+      topLevels += "scala" -> Member(scalaPckg.fullName, "", scalaPckg.dri, Kind.Package)
       topLevels += mergeAnyRefAliasAndObject(parser)
 
   def result(): (List[Member], Option[Comment]) =

scaladoc/src/dotty/tools/scaladoc/transformers/ImplicitMembersExtensionTransformer.scala

@@ -5,7 +5,7 @@ class ImplicitMembersExtensionTransformer(using DocContext) extends(Module => Mo
   override def apply(original: Module): Module =
     val classlikeMap = original.members
 
-    def retrieveCompanion(m: Member) = m.companion.flatMap { dri =>
+    def retrieveCompanion(m: Member) = m.companion.flatMap { (_, dri) =>
      val res = classlikeMap.get(dri)
       if res.isEmpty then
         report.warning(s"Companion for class ${m.name} exists but is missing in classlike map")

scaladoc/src/dotty/tools/scaladoc/translators/ScalaSignatureUtils.scala

@@ -72,7 +72,7 @@ case class SignatureBuilder(content: Signature = Nil) extends ScalaSignatureUtil
     if filtered.nonEmpty then keyword(filtered.toSignatureString()) else this
 
   def kind(t: Member) =
-    keyword(t.kind.name)
+    keyword(t.kind.name + " ")
 
   def generics(on: Seq[TypeParameter]) = list(on.toList, List(Plain("[")), List(Plain("]"))){ (bdr, e) =>
     bdr.annotationsInline(e).keyword(e.variance).tpe(e.name, Some(e.dri)).signature(e.signature)