fix actual javadoc error, and revert some changes

apache · Aug 15, 2024 · c7e56c8 · c7e56c8
1 parent 0cce057
commit c7e56c8
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 6 deletions.
diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
@@ -29,7 +29,6 @@ jobs:
       uses: actions/setup-java@v4
       with:
         java-version: 8
-        # cannot ignore javadoc violations on Zulu
         distribution: 'temurin'
     - name: Test
       run: |

diff --git a/phoenix5-hive/src/main/java/org/apache/phoenix/hive/ql/pushdown/PhoenixSearchCondition.java b/phoenix5-hive/src/main/java/org/apache/phoenix/hive/ql/pushdown/PhoenixSearchCondition.java
@@ -29,7 +29,7 @@
 
 /**
  * IndexSearchCondition represents an individual search condition found by
- * {@link IndexPredicateAnalyzer}.
+ * {@link PhoenixPredicateAnalyzer}.
  *
  */
 public class PhoenixSearchCondition {

diff --git a/phoenix5-hive4/src/main/java/org/apache/phoenix/hive/ql/pushdown/PhoenixSearchCondition.java b/phoenix5-hive4/src/main/java/org/apache/phoenix/hive/ql/pushdown/PhoenixSearchCondition.java
@@ -29,7 +29,7 @@
 
 /**
  * IndexSearchCondition represents an individual search condition found by
- * {@link IndexPredicateAnalyzer}.
+ * {@link PhoenixPredicateAnalyzer}.
  *
  */
 public class PhoenixSearchCondition {

diff --git a/pom.xml b/pom.xml
@@ -361,9 +361,6 @@
           <configuration>
             <source>8</source>
             <quiet>true</quiet>
-            <!-- Without this javadoc warnings fail the build on most JDKs.
-            Remove once javadoc is cleaned up -->
-            <additionalJOptions>-Xdoclint:none</additionalJOptions>
           </configuration>
         </plugin>
         <plugin>
@@ -430,6 +427,9 @@
             <goals>
               <goal>jar</goal>
             </goals>
+            <configuration>
+              <additionalparam>${javadoc.opts}</additionalparam>
+            </configuration>
           </execution>
         </executions>
       </plugin>
@@ -988,6 +988,16 @@
         <argLine>${phoenix-surefire.jdk11.flags} ${phoenix-surefire.jdk17.flags} ${phoenix-surefire.jdk17.tuning.flags} ${phoenix-surefire.argLine}</argLine>
       </properties>
     </profile>
+    <!-- disable doclint with 1.8+ JDKs -->
+    <profile>
+      <id>java8-doclint-disabled</id>
+      <activation>
+        <jdk>[1.8,)</jdk>
+      </activation>
+      <properties>
+        <javadoc.opts>-Xdoclint:none</javadoc.opts>
+      </properties>
+    </profile>
     <!-- Skip Javadoc for 1.8+ See PHOENIX-6922 -->
     <profile>
       <id>disable-javadoc-for-spark</id>