File tree Expand file tree Collapse file tree 1 file changed +8
-3
lines changed
dokka-subprojects/core/src/main/kotlin/org/jetbrains/dokka Expand file tree Collapse file tree 1 file changed +8
-3
lines changed Original file line number Diff line number Diff line change @@ -147,17 +147,22 @@ public interface DokkaConfiguration : Serializable {
147
147
/* *
148
148
* Whether coroutines dispatchers should be shutdown after
149
149
* generating documentation via [DokkaGenerator.generate].
150
+ * Additionally, whether the Analysis API and IJ platform global
151
+ * services should be shutdown.
150
152
*
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
152
157
* coroutines in order to make classes unloadable by the JVM,
153
158
* and rejects all new tasks with [RejectedExecutionException]
154
159
*
155
- * This is primarily useful for multi-module builds where coroutines
160
+ * This is primarily useful for multi-module builds where global services
156
161
* can be shut down after each module's partial task to avoid
157
162
* possible memory leaks.
158
163
*
159
164
* 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,
161
166
* and closing it down will leave the build in an inoperable state.
162
167
* One such example is unit tests, for which finalization should be disabled.
163
168
*/
You can’t perform that action at this time.
0 commit comments