Scala3doc: Fix searchbar to match only by name #10263
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pikinier20
force-pushed
the
searchbar-data-update
branch
from
32b847c to
410d1ca
Compare
romanowski
requested changes
Nov 10, 2020
| object PluginUtils: | ||
| import scala.reflect.ClassTag | ||
| import scala.reflect._ | ||
| def query[T <: DokkaPlugin, E](ctx: DokkaContext, queryFunction: (T) => ExtensionPoint[E])(implicit tag: ClassTag[T]): List[E] = |
There was a problem hiding this comment.
Maybe:
def plugin[T <: DokkaPlugin: ClassTag](ctx: DokkaContext) =
ctx.plugin[T](getKotlinClass(implicitly[ClassTag[T]].runtimeClass.asInstanceOf[Class[T]]))
def query[T <: DokkaPlugin: ClassTag, E](ctx: DokkaContext, queryFunction: (T) => ExtensionPoint[E]): List[E] =
ctx.get(queryFunction(plugin[T](ctx))).asScala.toList
def querySingle[T <: DokkaPlugin: ClassTag, E](ctx: DokkaContext, queryFunction: (T) => ExtensionPoint[E]): E =
ctx.single(queryFunction(plugin[T](ctx)))
| @@ -40,6 +41,19 @@ class SignatureRenderer(pageContext: ContentPage, sourceSetRestriciton: JSet[Dis | |||
|
|
|||
| class ScalaHtmlRenderer(ctx: DokkaContext) extends HtmlRenderer(ctx) { | |||
|
|
|||
| // TODO #239 | |||
| val hackScalaSearchbarDataInstaller: SearchbarDataInstaller = { | |||
| import java.lang.reflect.Field; | |||
There was a problem hiding this comment.
I think that code below will work as well (without nasty warnings):
val f = classOf[HtmlRenderer].getDeclaredField("searchbarDataInstaller")
f.setAccessible(true)
f.set(this, ScalaSearchbarDataInstaller(ctx))
f.get(this).asInstanceOf[ScalaSearchbarDataInstaller]
|
|
||
| case class PageEntry(val name: String, val signature: String, val link: String, val pkg: String) | ||
|
|
||
| val pages = TrieMap[String, PageEntry]() |
There was a problem hiding this comment.
Maybe we can add a comment that this is such a strange piece of code (concurrent collection, mutable state etc.) due to dokka?
| override def processPage(page: ContentPage, link: String) = | ||
| Option(page.getDocumentable) match { | ||
| case Some(member) => processMember(member, link) | ||
| case None => () |
There was a problem hiding this comment.
We need to add support for titles from static documentation nodes
pikinier20
force-pushed
the
searchbar-data-update
branch
2 times, most recently
from
55d6fe9 to
198d62e
Compare
romanowski
approved these changes
Nov 10, 2020
pikinier20
force-pushed
the
searchbar-data-update
branch
from
198d62e to
9e4bdc7
Compare
|
@smarter it seems that |
Not that I know of, /cc @liufengyun |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It's fix of a bug reported in #200