java.lang.OutOfMemoryError: Java heap space

[mahozad]

Describe the bug
When upgrading Dokka from 1.9.20 to 2.0.0-Beta, executing dokkaGenerate task fails:

...
> Task :wavy-slider:dokkaGenerateModuleHtml
> Task :wavy-slider:dokkaGeneratePublicationHtml

java.lang.OutOfMemoryError: Java heap space
Dumping heap to java_pid37140.hprof ...
java.lang.OutOfMemoryError: Java heap space
Dumping heap to java_pid20352.hprof ...
Heap dump file created [804336399 bytes in 7.145 secs]

> Task :wavy-slider:dokkaGenerateModuleHtml FAILED
Heap dump file created [804312093 bytes in 6.518 secs]
> Task :wavy-slider:dokkaGeneratePublicationHtml FAILED

Expected behaviour
Should generate HTML output.

To Reproduce
Please checkout this commit and apply the below dokka configs in library/build.gradle.kts and run ./gradlew wavy-slider:dokkaGenerate

Dokka configuration
gradle.properties:

org.jetbrains.dokka.experimental.gradle.pluginMode=V2EnabledWithHelpers

library/build.gradle.kts:

dokka {
    moduleName = "Hello"

    dokkaSourceSets.configureEach {
        reportUndocumented = true
        enableJdkDocumentationLink = true
        enableAndroidDocumentationLink = true
        enableKotlinStdLibDocumentationLink = true
        jdkVersion = libs.versions.java.get().toInt()
    }

    pluginsConfiguration.html {
        customStyleSheets.from(file("../asset/logo-styles.css"))
        customAssets.from(file("../asset/logo-icon.svg"))
        separateInheritedMembers = true
    }
}

Installation

• Operating system: Windows
• Build tool: Gradle v8.10.2
• Dokka version: 2.0.0-Beta

Additional context
Dokka 1.9.20 worked properly.

[whyoleg]

Hey!
Yeah, that's because Gradle Plugin v2 uses a bit different way of running Dokka generator/engine by default. We are thinking of changing it.
In the meanwhile, you can do that explicitly:

dokka {
    dokkaGeneratorIsolation = ClassLoaderIsolation()
}

For more information on what it does, you can take a look on updated extensive KDoc.

[mahozad]

Thank you. that resolved the problem.

[SakurajimaMaii]

Gradle version should also be above 8.10

[ShreckYe]

@whyoleg should this be added to the subprojects (the convention plugin), or the root project, or both, if I have a multi-module build?

[SakurajimaMaii]

@whyoleg should this be added to the subprojects (the convention plugin), or the root project, or both, if I have a multi-module build?

You can take a look at my project, maybe it can help you https://github.com/SakurajimaMaii/Android-Vast-Extension/tree/preview/kotlin-2.0.0/libraries

[ShreckYe]

@SakurajimaMaii OK thanks.

[whyoleg]

Hey!
We've made multiple improvements in the latest releases, which should improve the situation with memory consumption:
both in the default configuration in the Dokka Gradle plugin V2 in 2.0.0, as well as in memory usage in the Dokka generator in 2.1.0-Beta.

It would be nice if you could try dropping ClassLoaderIsolation and re-checking whether it works fine with Dokka 2.1.0-Beta.

[mahozad]

It works for me. Thanks.

When hovering over an item (entries in image below), the copy icon in the displayed square frame is not shown:

[whyoleg]

When hovering over an item (entries in image below)

That probably happens because you are opening index.html locally directly, but at this point Dokka requires web server, like in IDEA: #1795