Merge pull request #331 from sumitkp18/documentation/http_server_jetty

(#271) Documentation added for module: http_server_jetty
hexagontk · Oct 12, 2020 · 9079ee8 · 9079ee8
2 parents a2ec982 + fb370da
commit 9079ee8
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 1 deletion.
diff --git a/http_server_jetty/src/main/kotlin/JettyServletAdapter.kt b/http_server_jetty/src/main/kotlin/JettyServletAdapter.kt
@@ -20,6 +20,9 @@ import java.util.*
 import javax.servlet.DispatcherType
 import org.eclipse.jetty.server.Server as JettyServer
 
+/**
+ * Implements [ServerPort] using [JettyServer].
+ */
 class JettyServletAdapter : ServerPort {
     private var jettyServer: JettyServer? = null
 

diff --git a/http_server_jetty/src/test/kotlin/HelloWorld.kt b/http_server_jetty/src/test/kotlin/HelloWorld.kt
@@ -4,6 +4,9 @@ import com.hexagonkt.http.server.Server
 
 lateinit var server: Server
 
+/**
+ * Start a Hello World server, serving at path "/hello".
+ */
 fun main() {
     server = Server(JettyServletAdapter()) {
         get("/hello") {

diff --git a/http_server_jetty/src/test/kotlin/examples/Service.kt b/http_server_jetty/src/test/kotlin/examples/Service.kt
@@ -7,6 +7,10 @@ import com.hexagonkt.http.server.ServerPort
 import com.hexagonkt.http.server.jetty.JettyServletAdapter
 import com.hexagonkt.injection.InjectionManager
 
+/**
+ * [InjectionManager] instance to which an instance of [JettyServletAdapter]
+ * is bound for dependency Injection.
+ */
 val injector = InjectionManager.apply {
     bindObject<ServerPort>(JettyServletAdapter()) // Bind Jetty server to HTTP Server Port
 }

diff --git a/port_http_server/src/main/kotlin/ServerPort.kt b/port_http_server/src/main/kotlin/ServerPort.kt
@@ -11,7 +11,9 @@ interface ServerPort {
     fun runtimePort(): Int
 
     /**
-     * .
+     * Checks whether the server has been started.
+     *
+     * @return True if the server has started, else false.
      */
     fun started(): Boolean