Skip to content

Replace dokka transformers #11027

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.

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
Jan 14, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 0 additions & 20 deletions scala3doc/src/dotty/dokka/DottyDokkaPlugin.scala
Original file line number Diff line number Diff line change
Expand Up @@ -88,19 +88,6 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
}.overrideExtension(dokkaBase.getDocumentableToPageTranslator)
)

val packageHierarchyTransformer = extend(
_.extensionPoint(CoreExtensions.INSTANCE.getPageTransformer)
.fromRecipe(PackageHierarchyTransformer(_))
.before(dokkaBase.getRootCreator)
.overrideExtension(dokkaBase.getDefaultSamplesTransformer)
)

val inheritanceTransformer = extend(
_.extensionPoint(CoreExtensions.INSTANCE.getDocumentableTransformer)
.fromRecipe(InheritanceInformationTransformer(_))
.name("inheritanceTransformer")
)

val ourRenderer = extend(
_.extensionPoint(CoreExtensions.INSTANCE.getRenderer)
.fromRecipe { case ctx @ given DokkaContext => new ScalaHtmlRenderer }
Expand All @@ -113,13 +100,6 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
.overrideExtension(dokkaBase.getDocTagToContentConverter)
)

val implicitMembersExtensionTransformer = extend(
_.extensionPoint(CoreExtensions.INSTANCE.getDocumentableTransformer)
.fromRecipe { case ctx @ given DokkaContext =>
new ImplicitMembersExtensionTransformer
}.name("implicitMembersExtensionTransformer")
)

val customDocumentationProvider = extend(
_.extensionPoint(dokkaBase.getHtmlPreprocessors)
.fromRecipe{ case c @ given DokkaContext => new SitePagesCreator }
Expand Down
9 changes: 8 additions & 1 deletion scala3doc/src/dotty/dokka/ScalaModuleCreator.scala
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,12 @@ class ScalaModuleProvider(using ctx: DocContext) extends SourceToDocumentableTra
PropertyContainer.Companion.empty()
).withNewMembers(packageMembers).withKind(Kind.RootPackage).withDocs(rootDoc).asInstanceOf[DPackage]

new DModule(
val transformers = List(
ImplicitMembersExtensionTransformer(),
InheritanceInformationTransformer()
)

val module = new DModule(
sourceSet.getDisplayName,
JList(topLevelPackage),
JMap(),
Expand All @@ -43,6 +48,8 @@ class ScalaModuleProvider(using ctx: DocContext) extends SourceToDocumentableTra
PropertyContainer.Companion.empty() plus ModuleExtension(result.flatMap(flattenMember).toMap)
)

transformers.foldLeft(module)( (module, transformer) => transformer(module) )

object EmptyModuleProvider extends SourceToDocumentableTranslator:
override def invoke(sourceSet: DokkaSourceSet, cxt: DokkaContext, unused: Continuation[? >: DModule]) =
DModule("", JList(), Map.empty.asJava, null, Set(sourceSet).asJava, PropertyContainer.Companion.empty())
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ import org.jetbrains.dokka.model.properties._
import dotty.dokka.model._
import dotty.dokka.model.api._

class ImplicitMembersExtensionTransformer(using DocContext) extends DocumentableTransformer:
override def invoke(original: DModule, context: DokkaContext): DModule =
class ImplicitMembersExtensionTransformer(using context: DocContext) extends ModuleTransformer:
override def apply(original: DModule): DModule =
val classlikeMap = original.driMap
val logger = context.getLogger
val logger = context.logger

def retrieveCompanion(m: Member) = m.companion.flatMap { dri =>
val res = classlikeMap.get(dri)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import dotty.dokka.model._
import dotty.dokka.model.api._


class InheritanceInformationTransformer(val ctx: DokkaContext) extends DocumentableTransformer:
override def invoke(original: DModule, context: DokkaContext): DModule =
class InheritanceInformationTransformer(using context: DocContext) extends ModuleTransformer:
override def apply(original: DModule): DModule =
val subtypes = getSupertypes(original.getPackages.get(0)).groupBy(_._1).transform((k, v) => v.map(_._2))
original.updateMembers { m =>
val st: Seq[LinkToType] = subtypes.getOrElse(m.dri, Nil)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
package dotty.dokka

import org.jetbrains.dokka.model._

abstract trait ModuleTransformer:
def apply(m: DModule): DModule

This file was deleted.