build: fix javadoc warnings

jknack · jknack · commit 8bc1bcaa914e · 2025-10-28T19:28:14.000-03:00
diff --git a/etc/javadoc.sh b/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=false
+mvn javadoc:javadoc -P source -Dmaven.plugin.validation=VERBOSE -Dmaven.javadoc.failOnError=true -Dmaven.javadoc.failOnWarnings=true
diff --git a/modules/jooby-ebean/src/main/java/io/jooby/ebean/package-info.java b/modules/jooby-ebean/src/main/java/io/jooby/ebean/package-info.java
@@ -1,2 +1,3 @@
+/** Ebean module. */
 @edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault
 package io.jooby.ebean;
diff --git a/modules/jooby-flyway/src/main/java/io/jooby/flyway/package-info.java b/modules/jooby-flyway/src/main/java/io/jooby/flyway/package-info.java
@@ -1,2 +1,3 @@
+/** Flyway module. */
 @edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault
 package io.jooby.flyway;
diff --git a/modules/jooby-hibernate/src/main/java/io/jooby/hibernate/HibernateConfigurer.java b/modules/jooby-hibernate/src/main/java/io/jooby/hibernate/HibernateConfigurer.java
@@ -22,6 +22,9 @@
  */
 public class HibernateConfigurer {
 
+  /** Default constructor. */
+  public HibernateConfigurer() {}
+
   /**
    * Hook into bootstrap registry and customize it.
    *
diff --git a/modules/jooby-hibernate/src/main/java/io/jooby/hibernate/package-info.java b/modules/jooby-hibernate/src/main/java/io/jooby/hibernate/package-info.java
@@ -1,2 +1,3 @@
+/** Hibernate module. */
 @edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault
 package io.jooby.hibernate;
diff --git a/modules/jooby-hikari/src/main/java/io/jooby/hikari/package-info.java b/modules/jooby-hikari/src/main/java/io/jooby/hikari/package-info.java
@@ -1,2 +1,3 @@
+/** Hikari module. */
 @edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault
 package io.jooby.hikari;
diff --git a/modules/jooby-jdbi/src/main/java/io/jooby/jdbi/TransactionalRequest.java b/modules/jooby-jdbi/src/main/java/io/jooby/jdbi/TransactionalRequest.java
@@ -68,7 +68,7 @@
  */
 public class TransactionalRequest implements Filter {
 
-  private ServiceKey<Jdbi> key;
+  private final ServiceKey<Jdbi> key;
 
   private boolean enabledByDefault = true;
 
diff --git a/modules/jooby-jdbi/src/main/java/io/jooby/jdbi/package-info.java b/modules/jooby-jdbi/src/main/java/io/jooby/jdbi/package-info.java
@@ -1,2 +1,3 @@
+/** Jdbi module. */
 @edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault
 package io.jooby.jdbi;
diff --git a/modules/jooby-jdbi/src/main/java/module-info.java b/modules/jooby-jdbi/src/main/java/module-info.java
@@ -3,7 +3,7 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
-/** JDBI module. */
+/** Jdbi module. */
 module io.jooby.jdbi {
   exports io.jooby.jdbi;
 
diff --git a/modules/jooby-openapi/src/main/java/module-info.java b/modules/jooby-openapi/src/main/java/module-info.java
@@ -1,3 +1,4 @@
+/** Open API module. */
 module io.jooby.openapi {
   exports io.jooby.openapi;
 
diff --git a/modules/jooby-vertx-pg-client/src/main/java/io/jooby/vertx/pgclient/VertxPgConnectionModule.java b/modules/jooby-vertx-pg-client/src/main/java/io/jooby/vertx/pgclient/VertxPgConnectionModule.java
@@ -19,7 +19,7 @@
 import io.vertx.pgclient.PgConnectOptions;
 import io.vertx.pgclient.PgConnection;
 import io.vertx.sqlclient.SqlConnectOptions;
-import io.vertx.sqlclient.impl.SqlClientInternal;
+import io.vertx.sqlclient.internal.SqlClientBase;
 
 /**
  * These modules exist as part of the performance tests required by <a
@@ -77,10 +77,10 @@ protected void install(Jooby application, String name, SqlConnectOptions options
     var pgConnection = new VertxPgConnectionProxy(options.getDatabase());
     var provider = new VertxSqlClientProvider(options.getDatabase());
     registry.put(ServiceKey.key(PgConnection.class, name), pgConnection);
-    registry.put(ServiceKey.key(SqlClientInternal.class, name), provider);
+    registry.put(ServiceKey.key(SqlClientBase.class, name), provider);
 
     registry.putIfAbsent(ServiceKey.key(PgConnection.class), pgConnection);
-    registry.putIfAbsent(ServiceKey.key(SqlClientInternal.class), provider);
+    registry.putIfAbsent(ServiceKey.key(SqlClientBase.class), provider);
   }
 
   @Override
diff --git a/tests/src/test/java/examples/vertx/VertxSqlConnectionApp.java b/tests/src/test/java/examples/vertx/VertxSqlConnectionApp.java
@@ -23,6 +23,7 @@
 import io.vertx.core.Handler;
 import io.vertx.sqlclient.*;
 import io.vertx.sqlclient.impl.SqlClientInternal;
+import io.vertx.sqlclient.internal.SqlClientBase;
 
 public class VertxSqlConnectionApp extends Jooby {
   private static final String SELECT_WORLD = "SELECT id, randomnumber from WORLD where id=$1";
@@ -57,7 +58,7 @@ public class VertxSqlConnectionApp extends Jooby {
 
     this.selectWorldQuery = require(PreparedQueryType, "selectWorld");
     this.updateWorldQuery = require(PreparedQueryTypeList, "updateWorld");
-    this.sqlClient = require(SqlClientInternal.class);
+    this.sqlClient = require(SqlClientBase.class);
 
     onStarted(() -> require(DbController.class));
 

Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@`
`2`	`2`
`3`	`3`	`DIR=$(cd "$(dirname "$0")"; pwd)`
`4`	`4`
`5`		`-mvn javadoc:javadoc -P source -Dmaven.plugin.validation=VERBOSE -Dmaven.javadoc.failOnError=true -Dmaven.javadoc.failOnWarnings=false`
	`5`	`+mvn javadoc:javadoc -P source -Dmaven.plugin.validation=VERBOSE -Dmaven.javadoc.failOnError=true -Dmaven.javadoc.failOnWarnings=true`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
	`1`	`+/** Ebean module. */`
`1`	`2`	`@edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault`
`2`	`3`	`package io.jooby.ebean;`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
	`1`	`+/** Flyway module. */`
`1`	`2`	`@edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault`
`2`	`3`	`package io.jooby.flyway;`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,9 @@`
`22`	`22`	`*/`
`23`	`23`	`public class HibernateConfigurer {`
`24`	`24`
	`25`	`+ /** Default constructor. */`
	`26`	`+ public HibernateConfigurer() {}`
	`27`	`+`
`25`	`28`	`/**`
`26`	`29`	`* Hook into bootstrap registry and customize it.`
`27`	`30`	`*`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
	`1`	`+/** Hibernate module. */`
`1`	`2`	`@edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault`
`2`	`3`	`package io.jooby.hibernate;`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
	`1`	`+/** Hikari module. */`
`1`	`2`	`@edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault`
`2`	`3`	`package io.jooby.hikari;`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
	`1`	`+/** Jdbi module. */`
`1`	`2`	`@edu.umd.cs.findbugs.annotations.ReturnValuesAreNonnullByDefault`
`2`	`3`	`package io.jooby.jdbi;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+/** Open API module. */`
`1`	`2`	`module io.jooby.openapi {`
`2`	`3`	`exports io.jooby.openapi;`
`3`	`4`