build: fix some javadoc issues

jknack · jknack · commit cfc700d1fa3a · 2023-06-17T17:13:42.000-03:00
- published to maven central faild bc of missing javadoc jar file for `jooby-kotlin`
diff --git a/etc/javadoc.sh b/etc/javadoc.sh
@@ -2,4 +2,4 @@
 
 DIR=$(cd "$(dirname "$0")"; pwd)
 
-sh $DIR/maven.sh javadoc:javadoc -P source
+sh $DIR/maven.sh javadoc:javadoc -P source -Dmaven.plugin.validation=VERBOSE
diff --git a/jooby/src/main/java/module-info.java b/jooby/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * Jooby module.
+ */
 module io.jooby {
   exports io.jooby;
   exports io.jooby.annotation;
diff --git a/modules/jooby-avaje-jsonb/src/main/java/module-info.java b/modules/jooby-avaje-jsonb/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * Avaje jsonb module.
+ */
 module io.jooby.avaje.jsonb {
   exports io.jooby.avaje.jsonb;
 
diff --git a/modules/jooby-caffeine/src/main/java/module-info.java b/modules/jooby-caffeine/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * Caffeine module.
+ */
 module io.jooby.caffeine {
   exports io.jooby.caffeine;
 
diff --git a/modules/jooby-camel/src/main/java/io/jooby/camel/CamelModule.java b/modules/jooby-camel/src/main/java/io/jooby/camel/CamelModule.java
@@ -86,6 +86,7 @@ public CamelModule(@NonNull RouteBuilder route, RouteBuilder... routes) {
   /**
    * Creates a new camel module adding one or more routes.
    *
+   * @param camel Camel context.
    * @param route Route configuration.
    * @param routes Optional route configuration.
    */
@@ -114,6 +115,7 @@ public CamelModule(
    * Dependency Injection framework (if any), otherwise camel does basic/minimal injection using
    * {@link org.apache.camel.impl.engine.DefaultInjector}.
    *
+   * @param camel Camel context.
    * @param route Route configuration.
    * @param routes Optional route configuration.
    */
diff --git a/modules/jooby-conscrypt/src/main/java/module-info.java b/modules/jooby-conscrypt/src/main/java/module-info.java
@@ -6,6 +6,9 @@
 import io.jooby.SslProvider;
 import io.jooby.conscrypt.ConscryptSslProvider;
 
+/**
+ * Conscrypt module.
+ */
 module io.jooby.conscrypt {
   requires io.jooby;
   requires static com.github.spotbugs.annotations;
diff --git a/modules/jooby-ebean/src/main/java/module-info.java b/modules/jooby-ebean/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * Ebean module.
+ */
 module io.jooby.ebean {
   exports io.jooby.ebean;
 
diff --git a/modules/jooby-flyway/src/main/java/module-info.java b/modules/jooby-flyway/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * Flyway module.
+ */
 module io.jooby.flyway {
   exports io.jooby.flyway;
 
diff --git a/modules/jooby-freemarker/src/main/java/module-info.java b/modules/jooby-freemarker/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * Freemarker module.
+ */
 module io.jooby.freemarker {
   exports io.jooby.freemarker;
 
diff --git a/modules/jooby-graphiql/src/main/java/module-info.java b/modules/jooby-graphiql/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * GraphQL module.
+ */
 module io.jooby.graphiql {
   exports io.jooby.graphiql;
 
diff --git a/modules/jooby-graphql-playground/src/main/java/module-info.java b/modules/jooby-graphql-playground/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * GraphQL module.
+ */
 module io.jooby.graphql.playground {
   exports io.jooby.graphql.playground;
 
diff --git a/modules/jooby-graphql/src/main/java/module-info.java b/modules/jooby-graphql/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * GraphQL module.
+ */
 module io.jooby.graphql {
   exports io.jooby.graphql;
 
diff --git a/modules/jooby-gson/src/main/java/module-info.java b/modules/jooby-gson/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * Gson module.
+ */
 module io.jooby.gson {
   exports io.jooby.gson;
 
diff --git a/modules/jooby-guice/src/main/java/module-info.java b/modules/jooby-guice/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * Guice module.
+ */
 module io.jooby.guice {
   exports io.jooby.guice;
 
diff --git a/modules/jooby-hibernate/pom.xml b/modules/jooby-hibernate/pom.xml
@@ -21,7 +21,7 @@
 
     <!-- Hibernate -->
     <dependency>
-      <groupId>org.hibernate</groupId>
+      <groupId>org.hibernate.orm</groupId>
       <artifactId>hibernate-core</artifactId>
     </dependency>
 
diff --git a/modules/jooby-hibernate/src/main/java/io/jooby/hibernate/SessionRequest.java b/modules/jooby-hibernate/src/main/java/io/jooby/hibernate/SessionRequest.java
@@ -18,7 +18,7 @@
 import io.jooby.ServiceKey;
 
 /**
- * Attach {@link Session} and {@link javax.persistence.EntityManager} to the current request.
+ * Attach {@link Session} and {@link jakarta.persistence.EntityManager} to the current request.
  *
  * <p>The active {@link Session} is accessible via {@link SessionFactory#getCurrentSession()} for
  * the duration of the route pipeline.
diff --git a/modules/jooby-hibernate/src/main/java/module-info.java b/modules/jooby-hibernate/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * Hibernate module.
+ */
 module io.jooby.hibernate {
   exports io.jooby.hibernate;
 
diff --git a/modules/jooby-hikari/src/main/java/module-info.java b/modules/jooby-hikari/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * Hikari module.
+ */
 module io.jooby.hikari {
   exports io.jooby.hikari;
 
diff --git a/modules/jooby-jackson/src/main/java/module-info.java b/modules/jooby-jackson/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * Jackson module.
+ */
 module io.jooby.jackson {
   exports io.jooby.jackson;
 
diff --git a/modules/jooby-jdbi/src/main/java/module-info.java b/modules/jooby-jdbi/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * JDBI module.
+ */
 module io.jooby.jdbi {
   exports io.jooby.jdbi;
 
diff --git a/modules/jooby-jetty/src/main/java/module-info.java b/modules/jooby-jetty/src/main/java/module-info.java
@@ -6,6 +6,9 @@
 import io.jooby.Server;
 import io.jooby.jetty.JettyServer;
 
+/**
+ * Jetty module.
+ */
 module io.jooby.jetty {
   exports io.jooby.jetty;
 
diff --git a/modules/jooby-jstachio/src/main/java/module-info.java b/modules/jooby-jstachio/src/main/java/module-info.java
@@ -1,3 +1,8 @@
+/*
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 /**
  * See {@link io.jooby.jstachio.JStachioModule}
  *
diff --git a/modules/jooby-jte/src/main/java/module-info.java b/modules/jooby-jte/src/main/java/module-info.java
@@ -1,3 +1,11 @@
+/*
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
+/**
+ * JTE module.
+ */
 module io.jooby.jte {
   exports io.jooby.jte;
 
diff --git a/modules/jooby-kotlin/pom.xml b/modules/jooby-kotlin/pom.xml
@@ -22,6 +22,28 @@
         <artifactId>kotlin-maven-plugin</artifactId>
         <extensions>true</extensions>
       </plugin>
+      <plugin>
+        <groupId>org.jetbrains.dokka</groupId>
+        <artifactId>dokka-maven-plugin</artifactId>
+        <version>1.8.20</version>
+        <configuration>
+          <documentedVisibilities>
+            <visibility>PUBLIC</visibility>
+          </documentedVisibilities>
+          <suppressedFiles>
+            <file>${project.build.sourceDirectory}/io/jooby/internal</file>
+          </suppressedFiles>
+        </configuration>
+        <executions>
+          <execution>
+            <phase>package</phase>
+            <id>attach-javadocs-dokka</id>
+            <goals>
+              <goal>javadocJar</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
   </build>
 
diff --git a/modules/jooby-kotlin/src/main/kotlin/io/jooby/kt/Kooby.kt b/modules/jooby-kotlin/src/main/kotlin/io/jooby/kt/Kooby.kt
@@ -114,7 +114,29 @@ inline fun <T : Any> Context.form(klass: KClass<T>): T {
 inline fun <T : Any> Context.query(klass: KClass<T>): T {
   return this.query(klass.java)
 }
-/** Kooby: */
+
+/**
+ * Welcome to Jooby for Kotlin
+ *
+ * <p>Hello World:
+ *
+ * <pre>{@code
+ *
+ * import io.jooby.kt.runApp
+ *
+ * fun main(args: Array<String>) {
+ *    runApp(args) {
+ *      get ("/") { "Welcome to Jooby!" }
+ *    }
+ * }
+ *
+ * }</pre>
+ *
+ * More documentation at <a href="https://jooby.io">jooby.io</a>
+ *
+ * @author edgar
+ * @since 2.0.0
+ */
 open class Kooby constructor() : Jooby() {
 
   constructor(init: Kooby.() -> Unit) : this() {
diff --git a/modules/jooby-metrics/src/main/java/module-info.java b/modules/jooby-metrics/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * Metrics module.
+ */
 module io.jooby.metrics {
   exports io.jooby.metrics;
 
diff --git a/modules/jooby-mutiny/src/main/java/module-info.java b/modules/jooby-mutiny/src/main/java/module-info.java
@@ -1,6 +1,14 @@
+/*
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 import io.jooby.ResultHandler;
 import io.jooby.mutiny.Mutiny;
 
+/**
+ * Mutiny module.
+ */
 module io.jooby.mutiny {
   exports io.jooby.mutiny;
 
diff --git a/modules/jooby-netty/src/main/java/module-info.java b/modules/jooby-netty/src/main/java/module-info.java
@@ -6,6 +6,9 @@
 import io.jooby.Server;
 import io.jooby.netty.NettyServer;
 
+/**
+ * Netty module.
+ */
 module io.jooby.netty {
   exports io.jooby.netty;
 
diff --git a/modules/jooby-openapi/src/main/java/module-info.java b/modules/jooby-openapi/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * OpenAPI module
+ */
 module io.jooby.openapi {
   exports io.jooby.openapi;
 
diff --git a/modules/jooby-pac4j/src/main/java/module-info.java b/modules/jooby-pac4j/src/main/java/module-info.java
@@ -3,7 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
-
+/**
+ * Pac4j module
+ */
 module io.jooby.pac4j {
   exports io.jooby.pac4j;
 
diff --git a/modules/jooby-pebble/src/main/java/module-info.java b/modules/jooby-pebble/src/main/java/module-info.java
@@ -3,6 +3,9 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+/**
+ * Pebble module
+ */
 module io.jooby.pebble {
   exports io.jooby.pebble;
 
diff --git a/modules/jooby-reactor/src/main/java/module-info.java b/modules/jooby-reactor/src/main/java/module-info.java
@@ -1,6 +1,14 @@
+/*
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 import io.jooby.ResultHandler;
 import io.jooby.reactor.Reactor;
 
+/**
+ * Reactor module
+ */
 module io.jooby.reactor {
   exports io.jooby.reactor;
 
diff --git a/modules/jooby-redis/src/main/java/module-info.java b/modules/jooby-redis/src/main/java/module-info.java
@@ -3,6 +3,10 @@
  * Apache License Version 2.0 https://jooby.io/LICENSE.txt
  * Copyright 2014 Edgar Espina
  */
+
+/**
+ * Redis module.
+ */
 module io.jooby.redis {
   exports io.jooby.redis;
 
diff --git a/modules/jooby-rxjava3/src/main/java/module-info.java b/modules/jooby-rxjava3/src/main/java/module-info.java
@@ -1,6 +1,14 @@
+/*
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
 import io.jooby.ResultHandler;
 import io.jooby.rxjava3.Reactivex;
 
+/**
+ * Rx module.
+ */
 module io.jooby.rxjava3 {
   exports io.jooby.rxjava3;
 
diff --git a/modules/jooby-test/src/main/java/module-info.java b/modules/jooby-test/src/main/java/module-info.java
diff --git a/modules/jooby-thymeleaf/src/main/java/module-info.java b/modules/jooby-thymeleaf/src/main/java/module-info.java
diff --git a/modules/jooby-whoops/src/main/java/module-info.java b/modules/jooby-whoops/src/main/java/module-info.java
diff --git a/modules/jooby-yasson/src/main/java/module-info.java b/modules/jooby-yasson/src/main/java/module-info.java
diff --git a/pom.xml b/pom.xml

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`		`-sh $DIR/maven.sh javadoc:javadoc -P source`
	`5`	`+sh $DIR/maven.sh javadoc:javadoc -P source -Dmaven.plugin.validation=VERBOSE`