Uploaded image for project: 'OptaPlanner'
  1. OptaPlanner
  2. PLANNER-389

maven-javadoc-plugin fails the build on JDK8 because of <p/> usage in javadocs

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Minor Minor
    • 6.3.0.CR1
    • 6.3.0.Beta2
    • optaplanner-core
    • None
    • Hide

      1. Make sure you are running Java 8 (including the javadoc command)
      2. Run mvn clean install -Dfull from the root folder of the optaplanner repository

      Show
      1. Make sure you are running Java 8 (including the javadoc command) 2. Run mvn clean install -Dfull from the root folder of the optaplanner repository
    • NEW
    • NEW

      The maven-javadoc-plugin fails the build with syntactic checks on Java 8:

      Complete log: http://fpaste.org/245272/

      [INFO] --- maven-javadoc-plugin:2.10.1:jar (default) @ optaplanner-core ---
      [INFO] 
      Loading source files for package org.optaplanner.core.config.score.director...
      Loading source files for package org.optaplanner.core.config.score.definition...
      
      ...
      
      Loading source files for package org.optaplanner.core.api.solver...
      Constructing Javadoc information...
      Standard Doclet version 1.8.0_51
      Building tree for all the packages and classes...
      Generating /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/target/apidocs/org/optaplanner/core/config/score/director/ScoreDirectorFactoryConfig.html...
      
      ...
      
      Generating /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/target/apidocs/org/optaplanner/core/impl/solver/termination/package-use.html...
      Building index for all the packages and classes...
      Generating /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/target/apidocs/overview-tree.html...
      Generating /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/target/apidocs/index-all.html...
      Generating /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/target/apidocs/deprecated-list.html...
      Building index for all classes...
      Generating /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/target/apidocs/allclasses-frame.html...
      Generating /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/target/apidocs/allclasses-noframe.html...
      Generating /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/target/apidocs/index.html...
      Generating /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/target/apidocs/overview-summary.html...
      Generating /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/target/apidocs/help-doc.html...
      100 errors
      24 warnings
      [INFO] ------------------------------------------------------------------------
      [INFO] Reactor Summary:
      [INFO] 
      [INFO] OptaPlanner multiproject parent .................... SUCCESS [  1.924 s]
      [INFO] OptaPlanner core ................................... FAILURE [ 21.390 s]
      [INFO] OptaPlanner Benchmark .............................. SKIPPED
      [INFO] OptaPlanner examples ............................... SKIPPED
      [INFO] OptaPlanner webexamples ............................ SKIPPED
      [INFO] OptaPlanner documentation .......................... SKIPPED
      [INFO] OptaPlanner distribution ........................... SKIPPED
      [INFO] ------------------------------------------------------------------------
      [INFO] BUILD FAILURE
      [INFO] ------------------------------------------------------------------------
      [INFO] Total time: 24.966 s
      [INFO] Finished at: 2015-07-17T09:46:48+02:00
      [INFO] Final Memory: 62M/845M
      [INFO] ------------------------------------------------------------------------
      [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.10.1:jar (default) on project optaplanner-core: MavenReportException: Error while creating archive:
      [ERROR] Exit code: 1 - /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/config/score/trend/InitializingScoreTrendLevel.java:50: error: self-closing element not allowed
      [ERROR] * <p/>
      [ERROR] ^
      [ERROR] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/config/score/trend/InitializingScoreTrendLevel.java:53: error: self-closing element not allowed
      [ERROR] * <p/>
      [ERROR] ^
      
      ...
      
      [ERROR] /home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/src/main/java/org/optaplanner/core/api/solver/event/BestSolutionChangedEvent.java:77: warning: no @return
      [ERROR] public boolean isEveryProblemFactChangeProcessed() {
      [ERROR] ^
      [ERROR] 
      [ERROR] Command line was: /usr/java/jdk1.8.0_51/jre/../bin/javadoc -J-Xmx512m -J-Xms128m @options @packages
      [ERROR] 
      [ERROR] Refer to the generated Javadoc files in '/home/oskopek/git/droolsjbpm/optaplanner/optaplanner-core/target/apidocs' dir.
      [ERROR] -> [Help 1]
      [ERROR] 
      [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
      [ERROR] Re-run Maven using the -X switch to enable full debug logging.
      [ERROR] 
      [ERROR] For more information about the errors and possible solutions, please read the following articles:
      [ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
      [ERROR] 
      [ERROR] After correcting the problems, you can resume the build with the command
      [ERROR]   mvn <goals> -rf :optaplanner-core
      

      Only affects JDK 8, works on JDK 7 (and probably lower). Tested on versions: jdk1.8.0_51, jdk1.7.0_79.

      Possible fix direction: https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#BEJEFABE and http://stackoverflow.com/a/16743137/2713162

              oskopek Ondrej Skopek (Inactive)
              oskopek Ondrej Skopek (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: