The maven-javadoc-plugin on JDK 9
Mark Raynsford
org.openjdk at io7m.com
Sat Nov 18 19:10:21 UTC 2017
Hello.
We're in the process of trying to get the maven-javadoc-plugin to work
correctly when generating documentation for modules. I have a simple
test case here that fails:
https://github.com/io7m/maven-javadoc-bug-20171118
See the README.txt for the full build log and error messages.
I think, at a basic level, we want to do this:
javadoc \
-verbose \
-sourcepath "a/src/main/java:b/src/main/java:c/src/main/java" \
--module com.io7m.bugs.a,com.io7m.bugs.b,com.io7m.bugs.c
But this of course fails with:
javadoc: error - cannot use source path for multiple modules
com.io7m.bugs.a, com.io7m.bugs.b, com.io7m.bugs.c 1 error
I note that there's --module-source-path option, so I'd expect the
following to work:
javadoc \
-verbose \
--module-source-path \
"a/src/main/java:b/src/main/java:c/src/main/java" \
--module com.io7m.bugs.a,com.io7m.bugs.b,com.io7m.bugs.c
Unfortunately, this fails with:
javadoc: error - module com.io7m.bugs.a not found.
1 error
I can't get any more information out of the javadoc tool than that, so
I'm not sure exactly what's wrong. It's been suggested to me that the
problem might be that the --module-source-path expects each entry in the
path to be a directory containing a directory named after the
respective module, but that's obviously not going to happen in a
project with sources laid out in the Maven convention (unless we start
inserting symlinks everywhere).
What's the least painful way that we can update the javadoc plugin so
that it can generate JavaDoc for a given set of modules?
--
Mark Raynsford | http://www.io7m.com
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 833 bytes
Desc: OpenPGP digital signature
URL: <http://mail.openjdk.java.net/pipermail/javadoc-dev/attachments/20171118/c4d62dc8/attachment.bin>
More information about the javadoc-dev
mailing list