This repository was archived by the owner on Apr 19, 2023. It is now read-only.
This repository was archived by the owner on Apr 19, 2023. It is now read-only.
Running mvn package fails with JavaDoc errors #161
Description
When I run mvn package on Mac OS with Java 11 active, I see the following error:
... snip ...
Generating /Users/tim/src/oss/nailgun/nailgun-server/target/apidocs/help-doc.html...
1 error
34 warnings
[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary for nailgun-all 1.0.0:
[INFO]
[INFO] nailgun-all ........................................ SUCCESS [ 0.869 s]
[INFO] nailgun-server ..................................... FAILURE [ 4.165 s]
[INFO] nailgun-examples ................................... SKIPPED
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 5.142 s
[INFO] Finished at: 2019-04-05T09:32:55-06:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.0.1:jar (attach-javadocs) on project nailgun-server: MavenReportException: Error while generating Javadoc:
[ERROR] Exit code: 1 - javadoc: error - The code being documented uses modules but the packages defined in https://docs.oracle.com/javase/8/docs/api/ are in the unnamed module.
[ERROR] /Users/tim/src/oss/nailgun/nailgun-server/src/main/java/com/facebook/nailgun/NGClientListener.java:26: warning: no @param for reason
[ERROR] void clientDisconnected(NGClientDisconnectReason reason)
... snip (there are more) ...
See full build log
Should these be fixed? Should this linting be disabled? Should the docs be updated to instruct the user to workaround?
I was able to work-around with this:
mvn -Dmaven.javadoc.skip=true package