Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix KDoc reference #103

Merged
merged 1 commit into from
Jun 19, 2024
Merged

Fix KDoc reference #103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions ...ansport-ktor-server/src/jvmMain/kotlin/kotlinx/rpc/transport/ktor/server/KtorServerDsl.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ import kotlinx.coroutines.job
import kotlinx.rpc.rpcServerConfig

/**
* Adds an RPC route to the specified [Route]. Provides builder to configure [RPCServer] that will be used internally.
* Adds an RPC route to the specified [Route].
* Provides builder to configure [kotlinx.rpc.RPCServer] that will be used internally.
* Note that the [WebSockets] plugin is required for such a route to work.
*
* @param path The relative path on which RPC server should mount.
Expand All @@ -26,7 +27,8 @@ public fun Route.rpc(path: String, builder: RPCRoute.() -> Unit) {
}

/**
* Adds an RPC route to the specified [Route]. Provides builder to configure [RPCServer] that will be used internally.
* Adds an RPC route to the specified [Route].
* Provides builder to configure [kotlinx.rpc.RPCServer] that will be used internally.
* Note that the [WebSockets] plugin is required for such a route to work.
*
* @param builder Builder function to configure RPC server.
Expand Down