Bret McGuire created CASSJAVA-141:
-------------------------------------

             Summary: Finish fixing Javadoc linting errors on 3.x after update 
to JDK8
                 Key: CASSJAVA-141
                 URL: https://issues.apache.org/jira/browse/CASSJAVA-141
             Project: Apache Cassandra Java driver
          Issue Type: Improvement
            Reporter: Bret McGuire


With 3.13.0 we moved the minimum JDK support for Java6 to Java8.  When trying 
to stage this version for a vote we noted that "mvn javadoc:javadoc" was now 
failing with a large number of javadoc errors (and warnings), largely around 
missing params, return values, etc.  Some documentation suggests this was due 
to a doclint change in the javadoc tool between the versions.

An initial stab was made at fixing these javadoc errors with [this 
commit|https://github.com/apache/cassandra-java-driver/commit/2558a5678a68741c6a729c2ceeebc9b6c845b192]
 but the volume of changes was just too high.  In the end I settled on 
re-working the build to more clearly indicate where the javadoc configs reside 
and explicitly use a doclint value of "none" for 3.13.0 (the pom.xml changes in 
the above commit reflect this work).  This worked reasonably well as a 
short-term fix but over the medium-to-long term we should look at fixing the 
underlying javadoc errors and re-enabling doclint.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to