add kdocs for the config of startup

This commit is contained in:
InsanusMokrassar 2022-12-06 13:08:37 +06:00
parent 09d1047260
commit 4971326eca
1 changed files with 13 additions and 0 deletions

View File

@ -3,6 +3,19 @@ package dev.inmo.micro_utils.startup.launcher
import dev.inmo.micro_utils.startup.plugin.StartPlugin
import kotlinx.serialization.Serializable
/**
* Contains just [List] of [StartPlugin]s. In json this config should look like:
*
* ```json
* {
* "plugins": [
* "dev.inmo.micro_utils.startup.launcher.HelloWorldPlugin"
* ]
* }
* ```
*
* In the sample above [HelloWorldPlugin] will be loaded during startup of application
*/
@Serializable
data class Config(
val plugins: List<StartPlugin>