big ol' refactor to allow for multiple Dokka formats

- create DokkaPublication to handle each Dokka output - for each DokkaPublication, create format specific tasks/configurations/etc - create specific plugins for each Dokka output format - do a tonne of refactoring to get conventions working... - add @nested to some task props - group Gradle utils in a file
Kotlin · aSemy · Oct 11, 2022 · Oct 11, 2022 · Oct 11, 2022 · Oct 11, 2022
commit 203050c2d10f369662fc31ac8a6b393b2c1e750b
diff --git a/runners/gradle-plugin-2/build.gradle.kts b/runners/gradle-plugin-2/build.gradle.kts
@@ -8,6 8,7 @@ plugins {
  `java-test-fixtures`
 
  `jvm-test-suite`
  `test-report-aggregation`
 
  idea
 
@@ -47,6 48,20 @@ gradlePlugin {
  implementationClass = "org.jetbrains.dokka.gradle.DokkaPlugin"
  isAutomatedPublishing = true
  }
 
  fun registerDokkaPlugin(format: String, cls: String) {
  plugins.create("dokka${format.capitalize()}Plugin") {
  id = "org.jetbrains.dokka2.$format"
  displayName = "Dokka plugin 2 - $format"
  description = "Dokka, the Kotlin documentation tool"
  implementationClass = "org.jetbrains.dokka.gradle.formats.$cls"
  isAutomatedPublishing = true
  }
  }
  registerDokkaPlugin("gfm", "DokkaGfmPublicationPlugin")
  registerDokkaPlugin("html", "DokkaHtmlPublicationPlugin")
  registerDokkaPlugin("javadoc", "DokkaJavadocPublicationPlugin")
  registerDokkaPlugin("jekyll", "DokkaJekyllPublicationPlugin")
 }
 
 pluginBundle {
@@ -183,6 198,9 @@ testing.suites {
 
 
 tasks.withType<Test>().configureEach {
 
  mustRunAfter(tasks.withType<AbstractPublishToMaven>())
 
  testLogging {
  events = setOf(
  TestLogEvent.STARTED,

diff --git a/runners/gradle-plugin-2/src/main/kotlin/DokkaExtension.kt b/runners/gradle-plugin-2/src/main/kotlin/DokkaExtension.kt
@@ -2,59 2,51 @@ package org.jetbrains.dokka.gradle
 
 import org.gradle.api.NamedDomainObjectContainer
 import org.gradle.api.file.DirectoryProperty
-import org.gradle.api.model.ObjectFactory
 import org.gradle.api.provider.Property
-import org.jetbrains.dokka.gradle.dokka_configuration.DokkaModuleDescriptionGradleBuilder
 import org.jetbrains.dokka.gradle.dokka_configuration.DokkaPublication
 import org.jetbrains.dokka.gradle.dokka_configuration.DokkaSourceSetGradleBuilder
-import javax.inject.Inject
 
 /**
  * Configure the behaviour of the [DokkaPlugin].
  */
-abstract class DokkaExtension @Inject constructor(
- private val objects: ObjectFactory
-) {
 abstract class DokkaExtension {
 
  /** Default version used for Dokka dependencies */
  abstract val dokkaVersion: Property<String>
 
  /** Directory into which [DokkaPublication]s will be produced */
  abstract val dokkaPublicationDirectory: DirectoryProperty
 
  abstract val dokkaConfigurationsDirectory: DirectoryProperty
 
  /** Default Dokka cache directory */
  abstract val dokkaCacheDirectory: DirectoryProperty
 
 // abstract val dokkaConfigurations: NamedDomainObjectContainer<DokkaConfigurationGradleBuilder>
 
  abstract val moduleNameDefault: Property<String>
  abstract val moduleVersionDefault: Property<String>
 
  /**
- * Dokka Source Sets describe the source code that should be included in a Dokka Publication.
- *
- * Dokka will not generate documentation at least there is at least one Dokka Source Set.
- *
- * Only source sets that are contained within _this project_ should be included here.
- * To merge source sets from other projects, use the Gradle dependencies block.
  * String used to discriminate between source sets that originate from different Gradle subprojects
  *
- * ```kotlin
- * dependencies {
- * // merge :other-project into this project's Dokka Configuration
- * dokka(project(":other-project"))
- * }
- * ```
- *
- * Or, to include other Dokka Publications as a Module use
  * Defaults to [the path of the subproject][org.gradle.api.Project.getPath].
  */
  abstract val sourceSetScopeDefault: Property<String>
 
  /**
  * Configuration for creating Dokka Publications.
  *
- * ```kotlin
- * dependencies {
- * // include :other-project as a module in this project's Dokka Configuration
- * dokkaModule(project(":other-project"))
- * }
- * ```
  * Each publication will generate one Dokka site based on the included Dokka Source Sets.
  *
- * Dokka will merge Dokka Source Sets from other subprojects.
  * The type of site is determined by the Dokka Plugins. By default, an HTML site will be generated.
  */
- abstract val dokkaSourceSets: NamedDomainObjectContainer<DokkaSourceSetGradleBuilder>
  abstract val dokkaPublications: NamedDomainObjectContainer<DokkaPublication>
 
  /**
- * Dokka Module Descriptions describe an independent Dokka publication, and these
- * descriptions are used by _other_ Dokka Configurations.
  * Dokka Source Sets that describe source code in the local project (not subprojects)
  *
- * Only add a module if you want the Dokka Publication produced by _this project_ to be
- * included in the Dokka Publication of _another_ project.
  * These source sets will be added to all [dokkaPublications].
  */
- abstract val dokkaModules: NamedDomainObjectContainer<DokkaModuleDescriptionGradleBuilder>
-
  abstract val dokkaSourceSets: NamedDomainObjectContainer<DokkaSourceSetGradleBuilder>
 }