diff options
| author | Kamil Doległo <9080183+kamildoleglo@users.noreply.github.com> | 2020-11-25 13:17:51 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-25 13:17:51 +0100 |
| commit | 3fe3a934092cd844a6e0b691c87c367b9fc4d5b3 (patch) | |
| tree | 0ba15c94e832657be1c5a12ed5c00287a6a0bc5f /docs/src/doc | |
| parent | 78850b5786b7b2a767db1dbd7132a374b2f4f227 (diff) | |
| download | dokka-3fe3a934092cd844a6e0b691c87c367b9fc4d5b3.tar.gz dokka-3fe3a934092cd844a6e0b691c87c367b9fc4d5b3.tar.bz2 dokka-3fe3a934092cd844a6e0b691c87c367b9fc4d5b3.zip | |
Remove suspend from SourceToDocumentableTranslator (#1622)
* Remove suspend from SourceToDocumentableTranslator
* Introduce AsyncSourceToDocumentableTranslator
Co-authored-by: Marcin Aman <marcin.aman@gmail.com>
Diffstat (limited to 'docs/src/doc')
| -rw-r--r-- | docs/src/doc/docs/developer_guide/extension_points.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/src/doc/docs/developer_guide/extension_points.md b/docs/src/doc/docs/developer_guide/extension_points.md index b121c3f7..22272562 100644 --- a/docs/src/doc/docs/developer_guide/extension_points.md +++ b/docs/src/doc/docs/developer_guide/extension_points.md @@ -28,6 +28,14 @@ By default, two translators are created: After this step, all data from different source sets and languages are kept separately. +If you are using Kotlin it is recommended to make use of the asynchronous version, providing you implementation of `invokeSuspending`: + +```kotlin +interface AsyncSourceToDocumentableTranslator : SourceToDocumentableTranslator { + suspend fun invokeSuspending(sourceSet: DokkaConfiguration.DokkaSourceSet, context: DokkaContext): DModule +} +``` + ### Pre-merge documentation transform Here you can apply any transformation to model data before different source sets are merged. |