Improve docs

steep-wms · Nov 5, 2024 · a9f5be8 · a9f5be8
1 parent 2dd21ea
commit a9f5be8
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/main/kotlin/model/plugins/SetupAdapterPlugin.kt b/src/main/kotlin/model/plugins/SetupAdapterPlugin.kt
@@ -13,12 +13,12 @@ import kotlin.reflect.full.callSuspend
  *
  *     suspend fun mySetupAdapter(setup: model.setup.Setup,
  *       requiredCapabilities: Collection<String>,
- *       vertx: io.vertx.core.Vertx): model.setup.Setup,
+ *       vertx: io.vertx.core.Vertx): model.setup.Setup
  *
  * The function will be called with a setup to modify and a collection of
  * required capabilities the modified setup should meet. The function should
  * return a new setup instance or the original one if no modifications were
- * necessary.
+ * necessary. If required, the function can be a suspend function.
  */
 data class SetupAdapterPlugin(
     override val name: String,