Added javadoc to EmbeddedServer.scala

Author: Thomas Heslin

embedded-kafka/src/main/scala/net/manub/embeddedkafka/EmbeddedServer.scala

@@ -5,26 +5,55 @@ import org.apache.zookeeper.server.ServerCnxnFactory
 
 import scala.reflect.io.Directory
 
+/**
+  * Represents a running server with a method of stopping the instance.
+  */
 sealed trait EmbeddedServer {
 
   def stop(clearLogs: Boolean): Unit
 }
 
+/**
+  * An instance of an embedded Zookeeper server.
+  *
+  * @param factory    the server.
+  * @param logsDirs   the [[Directory]] logs are to be written to.
+  * @param config     the [[EmbeddedKafkaConfig]] used to start the factory.
+  */
 case class EmbeddedZ(factory: ServerCnxnFactory,
                      logsDirs: Directory)(
                       implicit config: EmbeddedKafkaConfig) extends EmbeddedServer {
 
+  /**
+    * Shuts down the factory and then optionally deletes the log directory.
+    *
+    * @param clearLogs  pass `true` to recursively delete the log directory.
+    */
   override def stop(clearLogs: Boolean) = {
     factory.shutdown()
     if (clearLogs) logsDirs.deleteRecursively()
   }
 }
 
+/**
+  * An instance of an embedded Kafka serer.
+  *
+  * @param factory    the optional [[EmbeddedZ]] server which Kafka relies upon.
+  * @param broker     the Kafka server.
+  * @param logsDirs   the [[Directory]] logs are to be written to.
+  * @param config     the [[EmbeddedKafkaConfig]] used to start the broker.
+  */
 case class EmbeddedK(factory: Option[EmbeddedZ],
                      broker: KafkaServer,
                      logsDirs: Directory)(
                       implicit config: EmbeddedKafkaConfig) extends EmbeddedServer {
 
+  /**
+    * Shuts down the broker and the factory it relies upon, if defined.
+    * Optionally deletes the log directory.
+    *
+    * @param clearLogs  pass `true` to recursively delete the log directory.
+    */
   override def stop(clearLogs: Boolean) = {
     broker.shutdown()
     broker.awaitShutdown()