Skip to content

Scala3doc: Simplify signatures in searchbar - remove annotations and modifiers #10505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 27, 2020
Merged

Scala3doc: Simplify signatures in searchbar - remove annotations and modifiers #10505

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 9 additions & 17 deletions scala3doc/src/dotty/renderers/ScalaSearchbarDataInstaller.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,10 @@ class ScalaSearchbarDataInstaller(val ctx: DokkaContext) extends SearchbarDataIn

case class PageEntry(val name: String, val signature: String, val link: String, val pkg: String)

// We need to use there mutable, concurrent collections because Dokka renders content concurrently
// We need to use there mutable, concurrent collections because Dokka renders content concurrently
// and adds entry to searchbar on start of processing page
val pages = TrieMap[String, PageEntry]()

val signatureProvider = querySingle[DokkaBase, SignatureProvider](ctx, _.getSignatureProvider)

override def processPage(page: ContentPage, link: String) =
Option(page.getDocumentable) match {
Expand All @@ -37,23 +36,16 @@ class ScalaSearchbarDataInstaller(val ctx: DokkaContext) extends SearchbarDataIn
}
}

def flattenToText(node: ContentNode): String = {
def getContentTextNodes(node: ContentNode, sourceSetRestriciton: DisplaySourceSet): List[ContentText] = node match {
case t: ContentText => List(t)
case c: ContentComposite if c.getDci.getKind != ContentKind.Annotations => c.getChildren.asScala
.filter(_.getSourceSets.asScala.contains(sourceSetRestriciton))
.flatMap(getContentTextNodes(_, sourceSetRestriciton))
.toList
case _ => List.empty
}

val sourceSetRestriciton = node.getSourceSets.asScala.find(_.getPlatform == Platform.common).getOrElse(node.getSourceSets.asScala.head)
getContentTextNodes(node, sourceSetRestriciton).map(_.getText).mkString("")
}
def flattenToText(signature: Signature): String =
signature.map {
case Link(name, dri) => name
case s: String => s
}.mkString

def processMember(member: Member, link: String) = {
val memberSignature = flattenToText(signatureProvider.signature(member).get(0))
val memberPackage = (Option(member.dri.getPackageName) ++ Option(member.dri.getClassNames) ++ Option(member.dri.getCallable)).mkString(".")
val signatureBuilder = ScalaSignatureProvider.rawSignature(member, InlineSignatureBuilder()).asInstanceOf[InlineSignatureBuilder]
val memberSignature = flattenToText(Seq(signatureBuilder.preName.head) ++ Seq(Link(member.name, member.dri)) ++ signatureBuilder.names.reverse)
val memberPackage = Option(member.dri.getPackageName).mkString
pages.addOne(memberSignature + link, PageEntry(member.name, memberSignature, link, memberPackage))
}

Expand Down