Skip to content

Commit 3536773

Browse files
authored
Merge pull request #11027 from lampepfl/replace-dokka-transformers
Replace dokka transformers
2 parents ae9cf23 + b143c92 commit 3536773

6 files changed

+19
-97
lines changed

scala3doc/src/dotty/dokka/DottyDokkaPlugin.scala

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -88,19 +88,6 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
8888
}.overrideExtension(dokkaBase.getDocumentableToPageTranslator)
8989
)
9090

91-
val packageHierarchyTransformer = extend(
92-
_.extensionPoint(CoreExtensions.INSTANCE.getPageTransformer)
93-
.fromRecipe(PackageHierarchyTransformer(_))
94-
.before(dokkaBase.getRootCreator)
95-
.overrideExtension(dokkaBase.getDefaultSamplesTransformer)
96-
)
97-
98-
val inheritanceTransformer = extend(
99-
_.extensionPoint(CoreExtensions.INSTANCE.getDocumentableTransformer)
100-
.fromRecipe(InheritanceInformationTransformer(_))
101-
.name("inheritanceTransformer")
102-
)
103-
10491
val ourRenderer = extend(
10592
_.extensionPoint(CoreExtensions.INSTANCE.getRenderer)
10693
.fromRecipe { case ctx @ given DokkaContext => new ScalaHtmlRenderer }
@@ -113,13 +100,6 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
113100
.overrideExtension(dokkaBase.getDocTagToContentConverter)
114101
)
115102

116-
val implicitMembersExtensionTransformer = extend(
117-
_.extensionPoint(CoreExtensions.INSTANCE.getDocumentableTransformer)
118-
.fromRecipe { case ctx @ given DokkaContext =>
119-
new ImplicitMembersExtensionTransformer
120-
}.name("implicitMembersExtensionTransformer")
121-
)
122-
123103
val customDocumentationProvider = extend(
124104
_.extensionPoint(dokkaBase.getHtmlPreprocessors)
125105
.fromRecipe{ case c @ given DokkaContext => new SitePagesCreator }

scala3doc/src/dotty/dokka/ScalaModuleCreator.scala

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,12 @@ class ScalaModuleProvider(using ctx: DocContext) extends SourceToDocumentableTra
3434
PropertyContainer.Companion.empty()
3535
).withNewMembers(packageMembers).withKind(Kind.RootPackage).withDocs(rootDoc).asInstanceOf[DPackage]
3636

37-
new DModule(
37+
val transformers = List(
38+
ImplicitMembersExtensionTransformer(),
39+
InheritanceInformationTransformer()
40+
)
41+
42+
val module = new DModule(
3843
sourceSet.getDisplayName,
3944
JList(topLevelPackage),
4045
JMap(),
@@ -43,6 +48,8 @@ class ScalaModuleProvider(using ctx: DocContext) extends SourceToDocumentableTra
4348
PropertyContainer.Companion.empty() plus ModuleExtension(result.flatMap(flattenMember).toMap)
4449
)
4550

51+
transformers.foldLeft(module)( (module, transformer) => transformer(module) )
52+
4653
object EmptyModuleProvider extends SourceToDocumentableTranslator:
4754
override def invoke(sourceSet: DokkaSourceSet, cxt: DokkaContext, unused: Continuation[? >: DModule]) =
4855
DModule("", JList(), Map.empty.asJava, null, Set(sourceSet).asJava, PropertyContainer.Companion.empty())

scala3doc/src/dotty/dokka/transformers/ImplicitMembersExtensionTransformer.scala

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ import org.jetbrains.dokka.model.properties._
1010
import dotty.dokka.model._
1111
import dotty.dokka.model.api._
1212

13-
class ImplicitMembersExtensionTransformer(using DocContext) extends DocumentableTransformer:
14-
override def invoke(original: DModule, context: DokkaContext): DModule =
13+
class ImplicitMembersExtensionTransformer(using context: DocContext) extends ModuleTransformer:
14+
override def apply(original: DModule): DModule =
1515
val classlikeMap = original.driMap
16-
val logger = context.getLogger
16+
val logger = context.logger
1717

1818
def retrieveCompanion(m: Member) = m.companion.flatMap { dri =>
1919
val res = classlikeMap.get(dri)

scala3doc/src/dotty/dokka/transformers/InheritanceInformationTransformer.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import dotty.dokka.model._
1010
import dotty.dokka.model.api._
1111

1212

13-
class InheritanceInformationTransformer(val ctx: DokkaContext) extends DocumentableTransformer:
14-
override def invoke(original: DModule, context: DokkaContext): DModule =
13+
class InheritanceInformationTransformer(using context: DocContext) extends ModuleTransformer:
14+
override def apply(original: DModule): DModule =
1515
val subtypes = getSupertypes(original.getPackages.get(0)).groupBy(_._1).transform((k, v) => v.map(_._2))
1616
original.updateMembers { m =>
1717
val st: Seq[LinkToType] = subtypes.getOrElse(m.dri, Nil)
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
package dotty.dokka
2+
3+
import org.jetbrains.dokka.model._
4+
5+
abstract trait ModuleTransformer:
6+
def apply(m: DModule): DModule

scala3doc/src/dotty/dokka/transformers/PackageHierarchyTransformer.scala

Lines changed: 0 additions & 71 deletions
This file was deleted.

0 commit comments

Comments
 (0)