From 3fe3a934092cd844a6e0b691c87c367b9fc4d5b3 Mon Sep 17 00:00:00 2001 From: Kamil Doległo <9080183+kamildoleglo@users.noreply.github.com> Date: Wed, 25 Nov 2020 13:17:51 +0100 Subject: Remove suspend from SourceToDocumentableTranslator (#1622) * Remove suspend from SourceToDocumentableTranslator * Introduce AsyncSourceToDocumentableTranslator Co-authored-by: Marcin Aman --- docs/src/doc/docs/developer_guide/extension_points.md | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'docs/src') 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. -- cgit