Fix javadoc errors

jknack · jknack · commit 7bf0963746d2 · 2019-07-09T17:30:22.000-03:00
diff --git a/etc/checkstyle.sh b/etc/checkstyle.sh
@@ -2,4 +2,6 @@
 
 DIR=$(cd "$(dirname "$0")"; pwd)
 
-sh $DIR/maven.sh checkstyle:checkstyle -P checkstyle
+if sh $DIR/maven.sh checkstyle:checkstyle -P checkstyle; then
+  sh $DIR/javadoc.sh
+fi
diff --git a/etc/prepare-release.sh b/etc/prepare-release.sh
@@ -2,5 +2,6 @@
 
 DIR=$(cd "$(dirname "$0")"; pwd)
 
-sh $DIR/javadoc.sh
-sh $DIR/versions.sh
+if sh $DIR/javadoc.sh; then
+  sh $DIR/versions.sh
+fi
diff --git a/modules/jooby-flyway/src/main/java/io/jooby/flyway/FlywayModule.java b/modules/jooby-flyway/src/main/java/io/jooby/flyway/FlywayModule.java
@@ -55,7 +55,7 @@ public class FlywayModule implements Extension {
   /**
    * Creates a new Flyway module.
    *
-   * @param name @param name The name/key of the data source to attach.
+   * @param name The name/key of the data source to attach.
    */
   public FlywayModule(@Nonnull String name) {
     this.name = name;
diff --git a/modules/jooby-hibernate/src/main/java/io/jooby/hibernate/HibernateModule.java b/modules/jooby-hibernate/src/main/java/io/jooby/hibernate/HibernateModule.java
@@ -58,7 +58,7 @@
  *
  * - Use it
  *
- * <pre>{code
+ * <pre>{@code
  * {
  *
  *   get("/", ctx -> {
@@ -71,7 +71,7 @@
  *
  * Optionally, you can require/inject a {@link SessionFactory} too:
  *
- * <pre>{code
+ * <pre>{@code
  * {
  *
  *   get("/", ctx -> {
diff --git a/modules/jooby-hikari/src/main/java/io/jooby/hikari/HikariModule.java b/modules/jooby-hikari/src/main/java/io/jooby/hikari/HikariModule.java
@@ -62,8 +62,9 @@
  *
  * To use any of these database you first need to add the h2 driver to your project and then:
  *
- * - define the `db` property in your application configuration file, like `db=mem` or
- * - pass the database type to the HikariModule. <code>`new HikariModule("mem")`</code>
+ * - define the <code>db</code> property in your application configuration file, like
+ *     <code>db=mem</code> or
+ * - pass the database type to the HikariModule. <code>new HikariModule("mem")</code>
  *
  * Alternative you can specify a jdbc connection string:
  *
@@ -74,6 +75,7 @@
  * The module exposes a {@link DataSource} instance which can be retrieve it after installing:
  *
  * <pre>{@code
+ *
  *    install(new HikariModule("jdbc:mysql://localhost/mydb"));
  *
  *    DataSource dataSource = require(DataSource.class);
@@ -180,8 +182,8 @@ public HikariModule(@Nonnull HikariConfig hikari) {
   /**
    * Get a database type from jdbc url. Examples:
    *
-   * - jdbc:mysql://localhost/mydb => mysql
-   * - jdbc:postgresql://server/database => postgresql
+   * - jdbc:mysql://localhost/mydb =&gt; mysql
+   * - jdbc:postgresql://server/database =&gt; postgresql
    *
    * @param url Jdbc connection string (a.k.a jdbc url)
    * @return Database type or given jdbc connection string for unknown or bad urls.
@@ -197,8 +199,8 @@ public HikariModule(@Nonnull HikariConfig hikari) {
   /**
    * Get a database name from jdbc url. Examples:
    *
-   * - jdbc:mysql://localhost/mydb => mydb
-   * - jdbc:postgresql://server/database => database
+   * - jdbc:mysql://localhost/mydb =&gt; mydb
+   * - jdbc:postgresql://server/database =&gt; database
    *
    * @param url Jdbc connection string (a.k.a jdbc url)
    * @return Database name.
diff --git a/modules/jooby-jdbi/src/main/java/io/jooby/jdbi/JdbiModule.java b/modules/jooby-jdbi/src/main/java/io/jooby/jdbi/JdbiModule.java
@@ -41,7 +41,7 @@
  *
  * - Use it
  *
- * <pre>{code
+ * <pre>{@code
  * {
  *
  *   get("/", ctx -> {
@@ -54,7 +54,7 @@
  *
  * Handle instances are also available:
  *
- * <pre>{code
+ * <pre>{@code
  * {
  *
  *   get("/", ctx -> {
@@ -98,7 +98,7 @@ public JdbiModule() {
   /**
    * Creates a new Jdbi module.
    *
-   * @param name @param name The name/key of the data source to attach.
+   * @param name The name/key of the data source to attach.
    */
   public JdbiModule(@Nonnull String name) {
     this.name = name;
diff --git a/modules/jooby-weld/src/main/java/io/jooby/di/WeldRegistry.java b/modules/jooby-weld/src/main/java/io/jooby/di/WeldRegistry.java
@@ -11,12 +11,11 @@
 import org.jboss.weld.environment.se.WeldContainer;
 
 import javax.annotation.Nonnull;
+import javax.enterprise.inject.Any;
 import javax.enterprise.inject.literal.NamedLiteral;
 
 import java.lang.annotation.Annotation;
 
-import static javax.enterprise.inject.Any.Literal.INSTANCE;
-
 class WeldRegistry implements Registry {
 
   private WeldContainer container;
@@ -43,6 +42,6 @@ class WeldRegistry implements Registry {
 
   private Annotation literal(ServiceKey key) {
     String name = key.getName();
-    return name == null ? INSTANCE : NamedLiteral.of(name);
+    return name == null ? Any.Literal.INSTANCE : NamedLiteral.of(name);
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ public class FlywayModule implements Extension {`
`55`	`55`	`/**`
`56`	`56`	`* Creates a new Flyway module.`
`57`	`57`	`*`
`58`		`- * @param name @param name The name/key of the data source to attach.`
	`58`	`+ * @param name The name/key of the data source to attach.`
`59`	`59`	`*/`
`60`	`60`	`public FlywayModule(@Nonnull String name) {`
`61`	`61`	`this.name = name;`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@`
`58`	`58`	`*`
`59`	`59`	`* - Use it`
`60`	`60`	`*`
`61`		`- * <pre>{code`
	`61`	`+ * <pre>{@code`
`62`	`62`	`* {`
`63`	`63`	`*`
`64`	`64`	`* get("/", ctx -> {`
`@@ -71,7 +71,7 @@`
`71`	`71`	`*`
`72`	`72`	`* Optionally, you can require/inject a {@link SessionFactory} too:`
`73`	`73`	`*`
`74`		`- * <pre>{code`
	`74`	`+ * <pre>{@code`
`75`	`75`	`* {`
`76`	`76`	`*`
`77`	`77`	`* get("/", ctx -> {`
Original file line number	Diff line number	Diff line change
`@@ -62,8 +62,9 @@`
`62`	`62`	`*`
`63`	`63`	`* To use any of these database you first need to add the h2 driver to your project and then:`
`64`	`64`	`*`
`65`		- * - define the `db` property in your application configuration file, like `db=mem` or
`66`		- * - pass the database type to the HikariModule. <code>`new HikariModule("mem")`</code>
	`65`	`+ * - define the <code>db</code> property in your application configuration file, like`
	`66`	`+ * <code>db=mem</code> or`
	`67`	`+ * - pass the database type to the HikariModule. <code>new HikariModule("mem")</code>`
`67`	`68`	`*`
`68`	`69`	`* Alternative you can specify a jdbc connection string:`
`69`	`70`	`*`
`@@ -74,6 +75,7 @@`
`74`	`75`	`* The module exposes a {@link DataSource} instance which can be retrieve it after installing:`
`75`	`76`	`*`
`76`	`77`	`* <pre>{@code`
	`78`	`+ *`
`77`	`79`	`* install(new HikariModule("jdbc:mysql://localhost/mydb"));`
`78`	`80`	`*`
`79`	`81`	`* DataSource dataSource = require(DataSource.class);`
`@@ -180,8 +182,8 @@ public HikariModule(@Nonnull HikariConfig hikari) {`
`180`	`182`	`/**`
`181`	`183`	`* Get a database type from jdbc url. Examples:`
`182`	`184`	`*`
`183`		`- * - jdbc:mysql://localhost/mydb => mysql`
`184`		`- * - jdbc:postgresql://server/database => postgresql`
	`185`	`+ * - jdbc:mysql://localhost/mydb => mysql`
	`186`	`+ * - jdbc:postgresql://server/database => postgresql`
`185`	`187`	`*`
`186`	`188`	`* @param url Jdbc connection string (a.k.a jdbc url)`
`187`	`189`	`* @return Database type or given jdbc connection string for unknown or bad urls.`
`@@ -197,8 +199,8 @@ public HikariModule(@Nonnull HikariConfig hikari) {`
`197`	`199`	`/**`
`198`	`200`	`* Get a database name from jdbc url. Examples:`
`199`	`201`	`*`
`200`		`- * - jdbc:mysql://localhost/mydb => mydb`
`201`		`- * - jdbc:postgresql://server/database => database`
	`202`	`+ * - jdbc:mysql://localhost/mydb => mydb`
	`203`	`+ * - jdbc:postgresql://server/database => database`
`202`	`204`	`*`
`203`	`205`	`* @param url Jdbc connection string (a.k.a jdbc url)`
`204`	`206`	`* @return Database name.`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@`
`41`	`41`	`*`
`42`	`42`	`* - Use it`
`43`	`43`	`*`
`44`		`- * <pre>{code`
	`44`	`+ * <pre>{@code`
`45`	`45`	`* {`
`46`	`46`	`*`
`47`	`47`	`* get("/", ctx -> {`
`@@ -54,7 +54,7 @@`
`54`	`54`	`*`
`55`	`55`	`* Handle instances are also available:`
`56`	`56`	`*`
`57`		`- * <pre>{code`
	`57`	`+ * <pre>{@code`
`58`	`58`	`* {`
`59`	`59`	`*`
`60`	`60`	`* get("/", ctx -> {`
`@@ -98,7 +98,7 @@ public JdbiModule() {`
`98`	`98`	`/**`
`99`	`99`	`* Creates a new Jdbi module.`
`100`	`100`	`*`
`101`		`- * @param name @param name The name/key of the data source to attach.`
	`101`	`+ * @param name The name/key of the data source to attach.`
`102`	`102`	`*/`
`103`	`103`	`public JdbiModule(@Nonnull String name) {`
`104`	`104`	`this.name = name;`