Skip to content

Commit e6548e9

Browse files
committed
Update README
1 parent 1e38b25 commit e6548e9

File tree

3 files changed

+16
-1
lines changed

3 files changed

+16
-1
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,9 @@ suspendTransform {
166166
enabled = true // default: true
167167
includeRuntime = true // default: true
168168
includeAnnotation = true // default: true
169+
// Note: If you disable includeAnnotation, you need to customise the `targetMarker` or set it to `null`.
170+
// see also: https://github.com/ForteScarlet/kotlin-suspend-transform-compiler-plugin/pull/73
171+
// targetMarker = ...
169172

170173
/*
171174
* Use both `useJvmDefault` and `useJsDefault`.
@@ -700,6 +703,9 @@ suspendTransform {
700703
// disable, use the runtime and the annotation by yourself
701704
includeRuntime = false
702705
includeAnnotation = false
706+
// Note: If you disable includeAnnotation, you need to customise the `targetMarker` or set it to `null`.
707+
// see also: https://github.com/ForteScarlet/kotlin-suspend-transform-compiler-plugin/pull/73
708+
targetMarker = null // or customise
703709

704710
addJvmTransformers(
705711
suspendTransTransformerForJvmBlocking,

README_CN.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,9 @@ suspendTransform {
164164
enabled = true // default: true
165165
includeRuntime = true // default: true
166166
includeAnnotation = true // default: true
167+
// 注意:如果禁用 includeAnnotation, 你需要自定义 targetMarker 或将其设置为 `null`
168+
// 更多参考: https://github.com/ForteScarlet/kotlin-suspend-transform-compiler-plugin/pull/73
169+
// targetMarker = null // 或自定义
167170

168171
/*
169172
* 相当于同时使用 `useJvmDefault` 和 `useJsDefault`.
@@ -240,6 +243,9 @@ suspendTransform {
240243
enabled = true // default: true
241244
includeRuntime = true // default: true
242245
includeAnnotation = true // default: true
246+
// 注意:如果禁用 includeAnnotation, 你需要自定义 targetMarker 或将其设置为 `null`
247+
// 更多参考: https://github.com/ForteScarlet/kotlin-suspend-transform-compiler-plugin/pull/73
248+
// targetMarker = null // 或自定义
243249

244250
/*
245251
* 相当于同时使用 `useJvmDefault` 和 `useJsDefault`.
@@ -702,6 +708,9 @@ suspendTransform {
702708
// 关闭它们,并使用你自己自定义的 runtime 和 annotation
703709
includeRuntime = false
704710
includeAnnotation = false
711+
// 注意:如果禁用 includeAnnotation, 你需要自定义 targetMarker 或将其设置为 `null`
712+
// 更多参考: https://github.com/ForteScarlet/kotlin-suspend-transform-compiler-plugin/pull/73
713+
targetMarker = null // 或自定义
705714

706715
addJvmTransformers(
707716
suspendTransTransformerForJvmBlocking,

settings.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ include(":plugins:suspend-transform-plugin-gradle")
3030
//Samples
3131
// include(":tests:test-jvm")
3232
// include(":tests:test-js")
33-
include(":tests:test-kmp")
33+
// include(":tests:test-kmp")

0 commit comments

Comments
 (0)