Merge pull request #3509 from FOCONIS/javadoc-fixes

RFC: Fix some javadoc issues
ebean-orm · Oct 31, 2024 · 9f5a77f · 9f5a77f
2 parents 4610dbb + 42ee75f
commit 9f5a77f
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 3 deletions.
diff --git a/ebean-api/src/main/java/io/ebean/DatabaseBuilder.java b/ebean-api/src/main/java/io/ebean/DatabaseBuilder.java
@@ -1968,8 +1968,8 @@ default DatabaseBuilder localOnlyL2Cache(boolean localOnlyL2Cache) {
   DatabaseBuilder setLocalOnlyL2Cache(boolean localOnlyL2Cache);
 
   /**
-   * Controls if Ebean should ignore <code>&x64;javax.validation.contstraints.NotNull</code> or
-   * <code>&x64;jakarta.validation.contstraints.NotNull</code>
+   * Controls if Ebean should ignore <code>&#64;javax.validation.contstraints.NotNull</code> or
+   * <code>&#64;jakarta.validation.contstraints.NotNull</code>
    * with respect to generating a <code>NOT NULL</code> column.
    * <p>
    * Normally when Ebean sees javax NotNull annotation it means that column is defined as NOT NULL.

diff --git a/ebean-core/pom.xml b/ebean-core/pom.xml
@@ -239,7 +239,7 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
         <configuration>
-          <doctitle>Ebean 12</doctitle>
+          <doctitle>Ebean 14</doctitle>
           <overview>src/main/java/io/ebean/overview.html</overview>
           <excludePackageNames>io.ebeaninternal.*:io.ebeanservice:io.ebean.common:io.ebean.bean:io.ebean.service:io.ebean.metric:io.ebean.util:io.ebean.config.properties:io.ebean.config.dbplatform</excludePackageNames>
           <linksource>true</linksource>

diff --git a/pom.xml b/pom.xml
@@ -56,6 +56,7 @@
     <ebean-agent.version>14.8.0</ebean-agent.version>
     <ebean-maven-plugin.version>14.8.0</ebean-maven-plugin.version>
     <surefire.useModulePath>false</surefire.useModulePath>
+    <maven-javadoc-plugin.version>3.10.1</maven-javadoc-plugin.version>
   </properties>
 
   <dependencies>
@@ -102,6 +103,20 @@
     <module>ebean-spring-txn</module>
   </modules>
 
+  <build>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-javadoc-plugin</artifactId>
+          <version>${maven-javadoc-plugin.version}</version>
+          <configuration>
+            <additionalOptions>-Xdoclint:none</additionalOptions>
+          </configuration>
+        </plugin>
+      </plugins>
+    </pluginManagement>
+  </build>
   <profiles>
     <profile>
       <id>central</id>