Skip to content

Commit 4fa533f

Browse files
committed
Edit KDoc of finalizeCoroutines
1 parent 09f60db commit 4fa533f

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

dokka-subprojects/core/src/main/kotlin/org/jetbrains/dokka/configuration.kt

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -147,17 +147,22 @@ public interface DokkaConfiguration : Serializable {
147147
/**
148148
* Whether coroutines dispatchers should be shutdown after
149149
* generating documentation via [DokkaGenerator.generate].
150+
* Additionally, whether the Analysis API and IJ platform global
151+
* services should be shutdown.
150152
*
151-
* It effectively stops all background threads associated with
153+
* If this is enabled, Coroutines *and* the Analysis API *and* IntelliJ
154+
* platform classes should no longer be used after the documentation is generated once.
155+
*
156+
* For example, it effectively stops all background threads associated with
152157
* coroutines in order to make classes unloadable by the JVM,
153158
* and rejects all new tasks with [RejectedExecutionException]
154159
*
155-
* This is primarily useful for multi-module builds where coroutines
160+
* This is primarily useful for multi-module builds where global services
156161
* can be shut down after each module's partial task to avoid
157162
* possible memory leaks.
158163
*
159164
* However, this can lead to problems in specific lifecycles where
160-
* coroutines are shared and will be reused after documentation generation,
165+
* global services are shared and will be reused after documentation generation,
161166
* and closing it down will leave the build in an inoperable state.
162167
* One such example is unit tests, for which finalization should be disabled.
163168
*/

0 commit comments

Comments
 (0)