mirror of
https://github.com/InsanusMokrassar/MicroUtils.git
synced 2024-11-22 16:23:50 +00:00
add kdocs for the config of startup
This commit is contained in:
parent
09d1047260
commit
4971326eca
@ -3,6 +3,19 @@ package dev.inmo.micro_utils.startup.launcher
|
|||||||
import dev.inmo.micro_utils.startup.plugin.StartPlugin
|
import dev.inmo.micro_utils.startup.plugin.StartPlugin
|
||||||
import kotlinx.serialization.Serializable
|
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
|
@Serializable
|
||||||
data class Config(
|
data class Config(
|
||||||
val plugins: List<StartPlugin>
|
val plugins: List<StartPlugin>
|
||||||
|
Loading…
Reference in New Issue
Block a user