build: fix javadoc error

- fix typos
- added missing javadoc comment
- fix links

Author: jknack

etc/javadoc.sh

@@ -2,4 +2,4 @@
 
 DIR=$(cd "$(dirname "$0")"; pwd)
 
-mvn javadoc:javadoc -P source -Dmaven.plugin.validation=VERBOSE -Dmaven.javadoc.failOnError=true -Dmaven.javadoc.failOnWarnings=true
+mvn javadoc:javadoc -P source -Dmaven.plugin.validation=VERBOSE -Dmaven.javadoc.failOnError=true -Dmaven.javadoc.failOnWarnings=false

jooby/src/main/java/io/jooby/problem/HttpProblem.java

@@ -27,14 +27,39 @@ public class HttpProblem extends RuntimeException {
 
   private static final URI DEFAULT_TYPE = URI.create("about:blank");
 
+  /** A problem occurrence timestamp in ISO-8601 representation. */
   private final String timestamp;
+
+  /**
+   * A URI reference that identifies the problem type. Consumers MUST use the "type" URI (after
+   * resolution, if necessary) as the problem type's primary identifier. When this member is not
+   * present, its value is assumed to be "about:blank". If the type URI is a locator (e.g., those
+   * with a "http" or "https" scheme), de-referencing it SHOULD provide human-readable documentation
+   * for the problem type (e.g., using HTML). However, consumers SHOULD NOT automatically
+   * dereference the type URI, unless they do so when providing information to developers (e.g.,
+   * when a debugging tool is in use)
+   */
   private final URI type;
+
+  /** Human-readable summary of this problem. */
   private final String title;
+
+  /** The HTTP status code generated by the origin server for this occurrence of the problem. */
   private final int status;
+
+  /** A human-readable explanation of this problem. */
   private final String detail;
+
+  /** An absolute URI that identifies this specific problem. */
   private final URI instance;
+
+  /** List of errors. */
   private final List<Error> errors;
+
+  /** Additional attributes of the problem. */
   private final Map<String, Object> parameters;
+
+  /** Optional headers. */
   private final Map<String, Object> headers;
 
   protected HttpProblem(Builder builder) {
@@ -334,9 +359,9 @@ public static class Builder {
     Builder() {}
 
     /**
-     * URI type.
+     * a URI that identifies this problem's type
      *
-     * @param type URI type.
+     * @param type a URI that identifies this problem's type
      * @return This builder.
      */
     public Builder type(@Nullable final URI type) {
@@ -345,9 +370,9 @@ public Builder type(@Nullable final URI type) {
     }
 
     /**
-     * Error's title.
+     * Human-readable summary of this problem.
      *
-     * @param title Error's title.
+     * @param title Human-readable summary of this problem.
      * @return This builder.
      */
     public Builder title(final String title) {

modules/jooby-apt/src/main/java/io/jooby/apt/JoobyProcessor.java

@@ -29,6 +29,7 @@
 
 import io.jooby.internal.apt.*;
 
+/** Process jooby/jakarta annotation and generate source code from MVC controllers. */
 @SupportedOptions({
   DEBUG,
   INCREMENTAL,
@@ -39,26 +40,61 @@
 })
 @SupportedSourceVersion(SourceVersion.RELEASE_17)
 public class JoobyProcessor extends AbstractProcessor {
+  /** Available options. */
   public interface Options {
+    /** Run code generator in debug mode. */
     String DEBUG = "jooby.debug";
+
+    /** Add custom prefix to generated class. Default: none/empty */
     String ROUTER_PREFIX = "jooby.routerPrefix";
+
+    /** Add custom suffix to generated class. Default: _ */
     String ROUTER_SUFFIX = "jooby.routerSuffix";
+
+    /** Gradle options to run in incremental mode. */
     String INCREMENTAL = "jooby.incremental";
+
+    /** Turn on/off generation of method metadata. */
     String MVC_METHOD = "jooby.mvcMethod";
+
+    /** Control which annotations are translated to route attributes. */
     String SKIP_ATTRIBUTE_ANNOTATIONS = "jooby.skipAttributeAnnotations";
 
+    /**
+     * Read a boolean option.
+     *
+     * @param environment Annotation processing environment.
+     * @param option Option's name.
+     * @param defaultValue Default value.
+     * @return Option's value.
+     */
     static boolean boolOpt(ProcessingEnvironment environment, String option, boolean defaultValue) {
       return Boolean.parseBoolean(
           environment.getOptions().getOrDefault(option, String.valueOf(defaultValue)));
     }
 
+    /**
+     * Read a string list option.
+     *
+     * @param environment Annotation processing environment.
+     * @param option Option's name.
+     * @return Option's value.
+     */
     static List<String> stringListOpt(ProcessingEnvironment environment, String option) {
       String value = string(environment, option, null);
       return value == null || value.isEmpty()
           ? List.of()
           : Stream.of(value.split(",")).filter(it -> !it.isBlank()).map(String::trim).toList();
     }
 
+    /**
+     * Read a string option.
+     *
+     * @param environment Annotation processing environment.
+     * @param option Option's name.
+     * @param defaultValue Default value.
+     * @return Option's value.
+     */
     static String string(ProcessingEnvironment environment, String option, String defaultValue) {
       String value = environment.getOptions().getOrDefault(option, defaultValue);
       return value == null || value.isEmpty() ? defaultValue : value;
@@ -68,10 +104,11 @@ static String string(ProcessingEnvironment environment, String option, String de
   protected MvcContext context;
   private BiConsumer<Diagnostic.Kind, String> output;
 
-  public JoobyProcessor(BiConsumer<Diagnostic.Kind, String> output) {
+  JoobyProcessor(BiConsumer<Diagnostic.Kind, String> output) {
     this.output = output;
   }
 
+  /** Default constructor. */
   public JoobyProcessor() {}
 
   @Override

modules/jooby-conscrypt/src/main/java/io/jooby/conscrypt/ConscryptSslProvider.java

@@ -20,6 +20,9 @@
 public class ConscryptSslProvider implements SslProvider {
   private static final String NAME = "Conscrypt";
 
+  /** Default constructor. */
+  public ConscryptSslProvider() {}
+
   @Override
   public String getName() {
     return NAME;

modules/jooby-conscrypt/src/main/java/io/jooby/conscrypt/package-info.java

@@ -1,2 +1,3 @@
+/** SSL support with conscrypt. */
 @edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault
 package io.jooby.conscrypt;

modules/jooby-conscrypt/src/main/java/module-info.java

@@ -6,7 +6,7 @@
 import io.jooby.SslProvider;
 import io.jooby.conscrypt.ConscryptSslProvider;
 
-/** Conscrypt module. */
+/** SSL Conscrypt module. */
 module io.jooby.conscrypt {
   requires io.jooby;
   requires static com.github.spotbugs.annotations;

modules/jooby-db-scheduler/src/main/java/io/jooby/dbscheduler/BeanTasks.java

@@ -18,7 +18,11 @@
 import io.jooby.Registry;
 import io.jooby.SneakyThrows;
 
-public class BeanTasks {
+/** Factory method for creating tasks from Java beans. */
+public final class BeanTasks {
+
+  private BeanTasks() {}
+
   /**
    * Scan for {@link Scheduled} annotated method and creates {@link Tasks#recurring(String,
    * Schedule)} tasks for each of them.

modules/jooby-db-scheduler/src/main/java/io/jooby/dbscheduler/DbScheduleParser.java

@@ -13,11 +13,21 @@
 import com.typesafe.config.ConfigException;
 
 /**
- * Parse {@link Schedule} from string expression. Supported values: - 0 0 1 * * ? (cron expression)
- * - 1m (fixed schedule) - 1h (fixed schedule) - 15s (fixed schedule) - DAILY|12:30,15:30 -
- * FIXED_DELAY|120s (must be expressed in seconds)
+ * Parse {@link Schedule} from string expression. Supported values:
+ *
+ * <ul>
+ *   <li>0 0 1 * * ? (cron expression)
+ *   <li>1m (fixed schedule)
+ *   <li>1h (fixed schedule)
+ *   <li>15s (fixed schedule)
+ *   <li>DAILY|12:30,15:30
+ *   <li>FIXED_DELAY|120s (must be expressed in seconds)
+ * </ul>
  */
-public class DbScheduleParser {
+public final class DbScheduleParser {
+
+  private DbScheduleParser() {}
+
   /**
    * Parse {@link Schedule} from string expression. Supported values: - 0 0 1 * * ? (cron
    * expression) - 1m (fixed schedule) - 1h (fixed schedule) - 15s (fixed schedule) -

modules/jooby-db-scheduler/src/main/java/io/jooby/dbscheduler/DbSchedulerApp.java

@@ -18,8 +18,10 @@
 import io.jooby.Jooby;
 import io.jooby.exception.NotFoundException;
 
+/** Minimal app that exposes {@link Scheduler} operations as API endpoints. */
 public class DbSchedulerApp extends Jooby {
-  {
+  /** Default constructor. */
+  public DbSchedulerApp() {
     get(
         "/",
         ctx -> {

modules/jooby-db-scheduler/src/main/java/io/jooby/dbscheduler/DbSchedulerModule.java

@@ -74,50 +74,109 @@ public class DbSchedulerModule implements Extension {
   private ScheduledExecutorService housekeeperExecutor;
   private JdbcCustomization jdbcCustomization;
 
+  /**
+   * Creates a new module.
+   *
+   * @param tasks Task to schedule.
+   */
   public DbSchedulerModule(@NonNull List<Task<?>> tasks) {
     this.tasks.addAll(tasks);
   }
 
+  /**
+   * Creates a new module.
+   *
+   * @param task Task to schedule.
+   * @param tail Tasks to schedule.
+   */
   public DbSchedulerModule(@NonNull Task<?> task, Task<?>... tail) {
     this(Stream.concat(Stream.of(task), Stream.of(tail)).toList());
   }
 
+  /**
+   * Add more task to schedule.
+   *
+   * @param tasks Tasks to schedule.
+   * @return This module.
+   */
   public DbSchedulerModule withTasks(@NonNull List<Task<?>> tasks) {
     this.tasks.addAll(tasks);
     return this;
   }
 
+  /**
+   * Set a stats registry.
+   *
+   * @param statsRegistry Stats registry.
+   * @return This module.
+   */
   public DbSchedulerModule withStatsRegistry(@NonNull StatsRegistry statsRegistry) {
     this.statsRegistry = statsRegistry;
     return this;
   }
 
+  /**
+   * Scheduler name.
+   *
+   * @param schedulerName Scheduler name.
+   * @return This module.
+   */
   public DbSchedulerModule withSchedulerName(@NonNull SchedulerName schedulerName) {
     this.schedulerName = schedulerName;
     return this;
   }
 
+  /**
+   * Set Task serializer.
+   *
+   * @param serializer Task serializer.
+   * @return This module.
+   */
   public DbSchedulerModule withSerializer(@NonNull Serializer serializer) {
     this.serializer = serializer;
     return this;
   }
 
+  /**
+   * Set task executor service.
+   *
+   * @param executorService Task executor service.
+   * @return This module.
+   */
   public DbSchedulerModule withExecutorService(@NonNull ExecutorService executorService) {
     this.executorService = executorService;
     return this;
   }
 
+  /**
+   * Set due executor service.
+   *
+   * @param dueExecutor Executor service.
+   * @return This module.
+   */
   public DbSchedulerModule withDueExecutor(@NonNull ExecutorService dueExecutor) {
     this.dueExecutor = dueExecutor;
     return this;
   }
 
+  /**
+   * Set cleanup executor service.
+   *
+   * @param housekeeperExecutor Executor service.
+   * @return This module.
+   */
   public DbSchedulerModule withHousekeeperExecutor(
       @NonNull ScheduledExecutorService housekeeperExecutor) {
     this.housekeeperExecutor = housekeeperExecutor;
     return this;
   }
 
+  /**
+   * Customize/configure jdbc calls.
+   *
+   * @param jdbcCustomization Customize/configure jdbc calls.
+   * @return This module.
+   */
   public DbSchedulerModule withJdbcCustomization(@NonNull JdbcCustomization jdbcCustomization) {
     this.jdbcCustomization = jdbcCustomization;
     return this;