build: fix javadoc error and warnings

- WIP

Author: jknack

jooby/src/main/java/io/jooby/AvailableSettings.java

@@ -20,8 +20,6 @@
  *   <li>via ENV variable, for example: <code>myprop=value java -jar myapp.jar</code>
  * </ul>
  *
- * <p>
- *
  * @since 3.0.0
  */
 public interface AvailableSettings {
@@ -45,8 +43,8 @@ public interface AvailableSettings {
   String LANG = "application.lang";
 
   /**
-   * Location of log configuration file. Used by {@link LogConfigurer} and setting up at application
-   * bootstrap time. You don't need to set this property.
+   * Location of log configuration file. Used by {@link LoggingService} and setting up at
+   * application bootstrap time. You don't need to set this property.
    */
   String LOG_FILE = "application.logfile";
 

jooby/src/main/java/io/jooby/CompletionListeners.java

@@ -20,6 +20,9 @@
 public class CompletionListeners {
   private List<Route.Complete> listeners;
 
+  /** Creates a new completion listener. */
+  public CompletionListeners() {}
+
   /**
    * Add a listener.
    *

jooby/src/main/java/io/jooby/Context.java

@@ -55,6 +55,12 @@ interface Selector {
      */
     Jooby select(String path);
 
+    /**
+     * Creates an application selector. Selection is done based on context path.
+     *
+     * @param applications List of applications.
+     * @return Selector.
+     */
     static Selector create(List<Jooby> applications) {
       return applications.size() == 1 ? single(applications.getFirst()) : multiple(applications);
     }
@@ -142,6 +148,11 @@ private static Selector single(Jooby defaultApp) {
    */
   Router getRouter();
 
+  /**
+   * Context output factory.
+   *
+   * @return Context output factory.
+   */
   OutputFactory getOutputFactory();
 
   /**
@@ -174,6 +185,11 @@ private static Selector single(Jooby defaultApp) {
    */
   @Nullable FlashMap flashOrNull();
 
+  /**
+   * Value factory.
+   *
+   * @return Value factory.
+   */
   ValueFactory getValueFactory();
 
   /**
@@ -1461,6 +1477,7 @@ static Context readOnly(@NonNull Context ctx) {
    * @param ctx Originating context.
    * @param ws WebSocket.
    * @param binary True for sending binary message.
+   * @param callback Write callback.
    * @return Read only context.
    */
   static Context websocket(

jooby/src/main/java/io/jooby/DefaultErrorHandler.java

@@ -28,13 +28,16 @@ public class DefaultErrorHandler implements ErrorHandler {
 
   private final Set<Class> muteTypes = new HashSet<>();
 
+  /** Default error handler. */
+  public DefaultErrorHandler() {}
+
   /**
    * Generate a log.debug call if any of the status code error occurs as exception.
    *
    * @param statusCodes Status codes to mute.
    * @return This error handler.
    */
-  public @NonNull DefaultErrorHandler mute(@NonNull StatusCode... statusCodes) {
+  public DefaultErrorHandler mute(@NonNull StatusCode... statusCodes) {
     muteCodes.addAll(List.of(statusCodes));
     return this;
   }
@@ -45,7 +48,7 @@ public class DefaultErrorHandler implements ErrorHandler {
    * @param exceptionTypes Exception types to mute.
    * @return This error handler.
    */
-  public @NonNull DefaultErrorHandler mute(@NonNull Class<? extends Exception>... exceptionTypes) {
+  public DefaultErrorHandler mute(@NonNull Class<? extends Exception>... exceptionTypes) {
     muteTypes.addAll(List.of(exceptionTypes));
     return this;
   }

jooby/src/main/java/io/jooby/ForwardingContext.java

@@ -37,6 +37,7 @@
  */
 public class ForwardingContext implements Context {
 
+  /** Delegate/forwarding body. */
   public static class ForwardingBody implements Body {
     protected final Body delegate;
 
@@ -317,6 +318,7 @@ public Map<String, String> toMap() {
     }
   }
 
+  /** Forwarding/Delegate pattern over {@link Value}. */
   public static class ForwardingValue implements Value {
     protected final Value delegate;
 
@@ -557,6 +559,7 @@ public Map<String, String> toMap() {
     }
   }
 
+  /** Forwarding/Delegate pattern over {@link QueryString}. */
   public static class ForwardingQueryString extends ForwardingValue implements QueryString {
     public ForwardingQueryString(QueryString queryString) {
       super(queryString);
@@ -573,6 +576,7 @@ public String queryString() {
     }
   }
 
+  /** Forwarding/Delegate pattern over {@link Formdata}. */
   public static class ForwardingFormdata extends ForwardingValue implements Formdata {
     public ForwardingFormdata(Formdata delegate) {
       super(delegate);

jooby/src/main/java/io/jooby/Jooby.java

@@ -1085,6 +1085,7 @@ public static void runApp(@NonNull String[] args, @NonNull Supplier<Jooby> provi
    * Setup default environment, logging (logback or log4j2) and run application.
    *
    * @param args Application arguments.
+   * @param server Web server.
    * @param provider Application provider.
    */
   public static void runApp(
@@ -1166,6 +1167,7 @@ public static void runApp(
    * Setup default environment, logging (logback or log4j2) and run application.
    *
    * @param args Application arguments.
+   * @param server Web server.
    * @param executionMode Default application execution mode. Can be overridden by application.
    * @param provider Application provider.
    */
@@ -1265,6 +1267,7 @@ public static void runApp(
   /**
    * Setup default environment, logging (logback or log4j2) and run application.
    *
+   * @param server Web server.
    * @param executionMode Application execution mode.
    * @param provider Application provider.
    * @return Application.

jooby/src/main/java/io/jooby/ModelAndView.java

@@ -18,6 +18,7 @@
  *
  * @since 2.0.0
  * @author edgar
+ * @param <T> Model type.
  */
 public class ModelAndView<T> {
 

jooby/src/main/java/io/jooby/annotation/Generated.java

@@ -10,8 +10,14 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+/** Used internally to annotation generated MVC controllers. */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.TYPE)
 public @interface Generated {
+  /**
+   * Target controller class.
+   *
+   * @return Target controller class.
+   */
   Class<?> value();
 }

jooby/src/main/java/io/jooby/annotation/OpenApiRegister.java

@@ -17,8 +17,8 @@
  * @OpenApiRegister({Controller1.class, Controller2.class})
  * public class App extends Jooby {
  *   ...
+ * }
  * }</pre>
- *
  */
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)

jooby/src/main/java/io/jooby/handler/AccessLogHandler.java

@@ -23,15 +23,14 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 import io.jooby.Context;
 import io.jooby.Route;
-import io.jooby.Router;
 
 /**
  * Access Log Handler.
  *
  * <p>Log incoming requested using the <a
  * href="https://en.wikipedia.org/wiki/Common_Log_Format">NCSA format</a> (a.k.a common log format).
  * If you run behind a reverse proxy that has been configured to send the X-Forwarded-* header,
- * please consider to set {@link Router#setTrustProxy(boolean)} option.
+ * please consider to set {@link io.jooby.RouterOptions#setTrustProxy(boolean)} option.
  *
  * <h2>usage</h2>
  *