Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix javadoc for java11 #1223

Closed
tomas-langer opened this issue Dec 12, 2019 · 2 comments
Closed

Fix javadoc for java11 #1223

tomas-langer opened this issue Dec 12, 2019 · 2 comments
Assignees
Labels
2.x Issues for 2.x version branch bug Something isn't working docs P2
Milestone

Comments

@tomas-langer
Copy link
Member

Javadoc fails with errors such as:

org.apache.maven.reporting.MavenReportException:
Exit code: 1 - javadoc: error - The code being documented uses modules but the packages defined in http://www.reactive-streams.org/reactive-streams-1.0.2-javadoc/ are in the unnamed module.

The documentation is actually generated.

For the time being, javadoc will not fail the build. This must be fixed before release.

@tomas-langer tomas-langer added bug Something isn't working docs labels Dec 12, 2019
@tomas-langer tomas-langer added this to the 2.0.0 milestone Dec 12, 2019
@tomas-langer tomas-langer mentioned this issue Dec 12, 2019
9 tasks
@m0mus m0mus added the P2 label Dec 12, 2019
tomas-langer added a commit to tomas-langer/helidon that referenced this issue Dec 13, 2019
See helidon-io#1220

Javadoc no longer fails the build. See helidon-io#1223 as a follow up issue.

Signed-off-by: Tomas Langer <tomas.langer@oracle.com>
tomas-langer added a commit that referenced this issue Dec 13, 2019
See #1220

Javadoc no longer fails the build. See #1223 as a follow up issue.

Signed-off-by: Tomas Langer <tomas.langer@oracle.com>
@tomas-langer tomas-langer added the 2.x Issues for 2.x version branch label Jan 16, 2020
@barchetta
Copy link
Member

Is this related to:

https://bugs.openjdk.java.net/browse/JDK-8212233

if so, a fix might be getting backported to 11. Although the issues implies it was fixed in 11.0.3, but maybe I'm not reading it right.

@barchetta
Copy link
Member

barchetta commented Mar 13, 2020

This has been addressed by #1386. The changes:

  1. Adding/updating module-info files
  2. Using the maven-javadoc-plugin aggregate goal (instead of the roll-our-own approach we had before). And running it as part of the site lifecycle. So there is no more "javadoc" module.
  3. Upgrading to version 3.2.0 of maven-javadoc-plugin to build the aggregated javadoc. This currently requires us to build that plugin from source since it isn't released yet (but the source is tagged). Expecting a release any day now.
  4. Commenting out cross reference links from the javadoc config (will need to fix this)
  5. Also, the documentation is now built as part of the site lifecycle.

To build the aggregated javadocs you run:

mvn site -Dversion.plugin.javadoc=3.2.0 -DskipTests -Pjavadoc

It will generate the aggregated javadocs and the documentation in the top level target directory. This currently requires you to build version 3.2.0 of the maven-javadoc-plugin yourself (see etc/build.sh). We expect it to be released any day now so this is a short term hack.

@barchetta barchetta self-assigned this Mar 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.x Issues for 2.x version branch bug Something isn't working docs P2
Projects
Archived in project
Development

No branches or pull requests

3 participants