Устранение неполадок в Dokka Gradle

Увеличение объёма памяти кучи

Один из способов решить проблемы с памятью — увеличить объём памяти кучи Java для процесса генератора Dokka. В файле build.gradle.kts измените следующий параметр конфигурации:

    dokka {
        // Dokka generates a new process managed by Gradle
        dokkaGeneratorIsolation = ProcessIsolation {
            // Configures heap size
            maxHeapSize = "4g"
        }
    }

В этом примере максимальный размер кучи установлен равным 4 ГБ ("4g"). Измените значение и протестируйте его, чтобы найти оптимальную настройку для вашей сборки.

Если окажется, что Dokka требуется значительно увеличить размер кучи, например, намного больше, чем требуется самому Gradle, создайте задачу в репозитории Dokka на GitHub.

Запуск Dokka в процессе Gradle

Если для сборки Gradle и создания документации Dokka требуется много памяти, они могут выполняться как отдельные процессы, потребляя значительный объём памяти на одном компьютере.

Чтобы оптимизировать использование памяти, можно запускать Dokka в том же процессе Gradle, а не как отдельный процесс. Это позволяет настроить память для Gradle один раз, вместо того чтобы выделять её отдельно для каждого процесса.

Чтобы запускать Dokka в том же процессе Gradle, измените следующий параметр конфигурации в файле build.gradle.kts:

    dokka {
        // Runs Dokka in the current Gradle process
        dokkaGeneratorIsolation = ClassLoaderIsolation()
    }

Как и в случае с увеличением объёма памяти кучи, протестируйте эту настройку, чтобы убедиться, что она хорошо подходит для вашего проекта.

Подробнее о настройке памяти JVM для Gradle см. в документации Gradle.