Skip to content

Commit

Permalink
Fix kDoc for KtorServerDsl (#103)
Browse files Browse the repository at this point in the history
  • Loading branch information
Mr3zee authored Jun 19, 2024
1 parent 430c5c6 commit 7ff376d
Showing 1 changed file with 4 additions and 2 deletions.
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

0 comments on commit 7ff376d

Please sign in to comment.