From 0bf1d0f5491a62c56393a06cdfb4168778d9829e Mon Sep 17 00:00:00 2001 From: Kamil Doległo <9080183+kamildoleglo@users.noreply.github.com> Date: Mon, 5 Jul 2021 14:10:23 +0200 Subject: Flatten multi-module structure (#1980) * Add support for multimodule package lists * Merge package-lists in multi-module generation * Remove double-wrapping of modules in multi-module generation * Handle empty modules in package lists --- .../main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt | 3 ++- .../org/jetbrains/dokka/javadoc/pages/JavadocPageNodes.kt | 4 ++-- .../dokka/javadoc/packagelist/JavadocPackageListTest.kt | 10 +++++----- 3 files changed, 9 insertions(+), 8 deletions(-) (limited to 'plugins/javadoc/src') diff --git a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt index 0bbbbf86..7f90f1ce 100644 --- a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt +++ b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt @@ -7,6 +7,7 @@ import org.jetbrains.dokka.CoreExtensions import org.jetbrains.dokka.base.DokkaBase import org.jetbrains.dokka.base.renderers.PackageListCreator import org.jetbrains.dokka.base.renderers.RootCreator +import org.jetbrains.dokka.base.resolvers.shared.PackageList.Companion.PACKAGE_LIST_NAME import org.jetbrains.dokka.base.resolvers.shared.RecognizedLinkFormat import org.jetbrains.dokka.javadoc.pages.* import org.jetbrains.dokka.javadoc.transformers.documentables.JavadocDocumentableJVMSourceSetFilter @@ -56,7 +57,7 @@ class JavadocPlugin : DokkaPlugin() { PackageListCreator( context = it, format = RecognizedLinkFormat.DokkaJavadoc, - outputFilesNames = listOf("package-list", "element-list") + outputFilesNames = listOf(PACKAGE_LIST_NAME, "element-list") ) } order { after(rootCreator) } } diff --git a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/pages/JavadocPageNodes.kt b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/pages/JavadocPageNodes.kt index aee38596..6d04093e 100644 --- a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/pages/JavadocPageNodes.kt +++ b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/pages/JavadocPageNodes.kt @@ -270,10 +270,10 @@ class AllClassesPage(val classes: List) : JavadocPageN dri: Set, embeddedResources: List, children: List - ): ContentPage = TODO() + ): ContentPage = this override fun modified(name: String, children: List): PageNode = - TODO() + this override val children: List = emptyList() diff --git a/plugins/javadoc/src/test/kotlin/org/jetbrains/dokka/javadoc/packagelist/JavadocPackageListTest.kt b/plugins/javadoc/src/test/kotlin/org/jetbrains/dokka/javadoc/packagelist/JavadocPackageListTest.kt index 431f4464..89e4c535 100644 --- a/plugins/javadoc/src/test/kotlin/org/jetbrains/dokka/javadoc/packagelist/JavadocPackageListTest.kt +++ b/plugins/javadoc/src/test/kotlin/org/jetbrains/dokka/javadoc/packagelist/JavadocPackageListTest.kt @@ -32,8 +32,8 @@ internal class JavadocPackageListTest : AbstractJavadocTemplateMapTest() { package0 package1 """.trimIndent() - assertEquals(expected, contents["/element-list"]?.trimIndent()) - assertEquals(expected, contents["/package-list"]?.trimIndent()) + assertEquals(expected, contents["element-list"]?.trimIndent()) + assertEquals(expected, contents["package-list"]?.trimIndent()) } } @@ -69,8 +69,8 @@ internal class JavadocPackageListTest : AbstractJavadocTemplateMapTest() { package0.package0Inner package1.package1Inner.package1InnerInner """.trimIndent() - assertEquals(expected, contents["/element-list"]?.trimIndent()) - assertEquals(expected, contents["/package-list"]?.trimIndent()) + assertEquals(expected, contents["element-list"]?.trimIndent()) + assertEquals(expected, contents["package-list"]?.trimIndent()) } } -} \ No newline at end of file +} -- cgit