Add javadocs

Author: RomanQed

src/main/java/io/github/amayaframework/jetty/JettyFactory.java

@@ -5,20 +5,24 @@
 import org.eclipse.jetty.server.Server;
 
 /**
- *
+ * An interface describing an abstract jetty {@link Server} factory.
  */
 public interface JettyFactory {
 
     /**
-     * @param handler
-     * @param options
-     * @return
+     * Creates a {@link Server} instance with the specified {@link Handler} implementation and {@link OptionSet}.
+     *
+     * @param handler the final handler that contains the logic for processing the http request, must be executed last
+     * @param options the option set containing jetty server options
+     * @return the {@link Server} instance
      */
     Server create(Handler handler, OptionSet options);
 
     /**
-     * @param handler
-     * @return
+     * Creates a {@link Server} instance with the specified {@link Handler} implementation.
+     *
+     * @param handler the final handler that contains the logic for processing the http request, must be executed last
+     * @return the {@link Server} instance
      */
     Server create(Handler handler);
 }

src/main/java/io/github/amayaframework/jetty/JettyOptions.java

@@ -1,35 +1,37 @@
 package io.github.amayaframework.jetty;
 
 /**
- *
+ * A class containing the names of the main server options supported by the {@link JettyServerFactory}.
  */
 public final class JettyOptions {
     /**
+     * The name of the server options group.
      *
+     * @see io.github.amayaframework.options.GroupOptionSet
      */
     public static final String GROUP = "jetty";
     /**
-     *
+     * The name of the listen port option. Required type: {@link Integer}.
      */
     public static final String PORT = "port";
     /**
-     *
+     * The name of the listen ports option. Required type: {@link Iterable} of {@link Integer}.
      */
     public static final String PORTS = "ports";
     /**
-     *
+     * The name of the listen ip option. Required type: {@link java.net.InetSocketAddress}.
      */
     public static final String IP = "ip";
     /**
-     *
+     * The name of the listen ips option. Required type: {@link Iterable} of {@link java.net.InetSocketAddress}.
      */
     public static final String IPS = "ips";
     /**
-     *
+     * The name of the initial http version. Required type: {@link io.github.amayaframework.http.HttpVersion}.
      */
     public static final String HTTP_VERSION = "http_version";
     /**
-     *
+     * The name of the flag determines whether the server will support http sessions. Required type: {@link Boolean}.
      */
     public static final String ENABLE_SESSIONS = "enable_sessions";
 

src/main/java/io/github/amayaframework/jetty/JettyServerFactory.java

@@ -15,30 +15,36 @@
 import java.util.function.Supplier;
 
 /**
- *
+ * A class that implements {@link HttpServerFactory}. Creates an implementations of {@link HttpServer}
+ * based on jetty {@link Server}.
  */
 public final class JettyServerFactory implements HttpServerFactory {
     private final JettyFactory factory;
     private final Supplier<ThreadPool> supplier;
 
     /**
-     * @param factory
+     * Constructs a {@link JettyServerFactory} instance with the given {@link JettyFactory}.
+     *
+     * @param factory the specified factory that will be used to create the {@link Server} instance
      */
     public JettyServerFactory(JettyFactory factory) {
         this.factory = factory;
         this.supplier = null;
     }
 
     /**
-     * @param supplier
+     * Constructs a {@link JettyServerFactory} instance with the given supplier of {@link ThreadPool}.
+     *
+     * @param supplier the specified supplier provides {@link ThreadPool} instance
      */
     public JettyServerFactory(Supplier<ThreadPool> supplier) {
         this.factory = null;
         this.supplier = supplier;
     }
 
     /**
-     *
+     * Constructs a {@link JettyServerFactory} instance which will use the default settings
+     * ({@link org.eclipse.jetty.util.thread.QueuedThreadPool} and {@link Server} with sessions support).
      */
     public JettyServerFactory() {
         this.factory = null;