annotations/io.github.kingg22.ktorgen.core/KtorGenFunction

KtorGenFunction

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class KtorGenFunction(val generate: Boolean = true, val customHeader: String = "")(source)

Indicates that a method within a @KtorGen-annotated interface should participate in code generation.

Example

interface UserRoutes {
    @GET("/users")
    suspend fun getUsers(): List<User>

    @KtorGenFunction(generate = false)
    @JvmSynthetic
    @ExperimentalApi
    fun getUsersBlocking(): List<User> = runBlocking { getUsers() }
}

In the above example, the getUsersBlocking function will not be overridden by KtorGen.

Properties

customHeader

val customHeader: String

Custom KDoc comment for the generated implementation class.

generate

val generate: Boolean = true

Indicate the annotated function going to generate the code or not.

KtorGenFunction

See also

Properties