Download Latest Version v2.4.0 source code.tar.gz (5.3 MB)
Email in envelope

Get an email when there's a new version of Dokkatoo

Home / v2.1.0
Name Modified Size InfoDownloads / Week
Parent folder
README.md 2024-02-12 6.0 kB
0
v2.1.0 source code.tar.gz 2024-02-12 1.0 MB
0
v2.1.0 source code.zip 2024-02-12 1.3 MB
0
Totals: 3 Items   2.4 MB 0

This new release of Dokkatoo brings some significant under-the-hood changes.

Automatic all-projects-page-plugin dependency

Manually adding the all-projects-page-plugin is no longer necessary for multi-module projects - please remove this workaround:

:::diff
 dependencies {
   // If using Dokkatoo v2.1.0+ a manual dependency on all-modules-page-plugin is no longer required:
-  dokkatooPluginHtml(
-    dokkatoo.versions.jetbrainsDokka.map { dokkaVersion ->
-      "org.jetbrains.dokka:all-modules-page-plugin:$dokkaVersion"
-    }
-  )
 }

If necessary, Dokkatoo will detect when all-projects-page-plugin is missing and log a warning to help diagnose problems.

Full Build Cache compatibility

Dokkatoo can now correctly use remote-build cache)

Updated default Dokka version to 1.9.10

If you manually overrode the version of Dokka that Dokkatoo uses and you want to use the default version, you can remove this.)

Improved handling of Android projects

Android projects with variants should be better supported - feedback is appreciated!)

Configurable Worker Isolation

In previous versions Dokkatoo ran Dokka Generator in a process isolated worker. For some projects this might be undesirable.

Dokkatoo can also run Dokka Generator in the current Gradle process, but with an isolated classpath.

:::kotlin
// build.gradle.kts

dokkatoo {
  dokkaGeneratorIsolation.set(
    ClassLoaderIsolation()
  )
}

dokkaGeneratorIsolation can also be used to configure the default JVM parameters for running Dokka Generator in Process Isolation mode:

:::kotlin
// build.gradle.kts

dokkatoo {
  dokkaGeneratorIsolation.set(
    ProcessIsolation {
      debug.set(false)
      enableAssertions.set(true)
      minHeapSize.set("64m")
      maxHeapSize.set("512m")
      // ...
    }
  )
}

Pull Request details

New Contributors

Full Changelog: https://github.com/adamko-dev/dokkatoo/compare/v2.0.0...v2.1.0

Source: README.md, updated 2024-02-12